Show / Hide Table of Contents

Class BatchContext

Representation of a batch context and its configurations.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Inheritance
object
BatchContext
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.BatchService.Models
Assembly: OCI.DotNetSDK.Batch.dll
Syntax
public class BatchContext

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment.

Remarks

Required

DefinedTags

Declaration
[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}

Remarks

Required

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Summarized information about the batch context.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name. Does not have to be unique, and it's changeable.

Remarks

Required

Entitlements

Declaration
[Required(ErrorMessage = "Entitlements is required.")]
[JsonProperty(PropertyName = "entitlements")]
public Dictionary<string, int> Entitlements { get; set; }
Property Value
Type Description
Dictionary<string, int>

Mapping of concurrent/shared resources used in job tasks to their limits.

Remarks

Required

Fleets

Declaration
[Required(ErrorMessage = "Fleets is required.")]
[JsonProperty(PropertyName = "fleets")]
public List<Fleet> Fleets { get; set; }
Property Value
Type Description
List<Fleet>

List of fleet configurations related to the batch context.

Remarks

Required

FreeformTags

Declaration
[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}

Remarks

Required

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the batch context.

Remarks

Required

JobPriorityConfigurations

Declaration
[Required(ErrorMessage = "JobPriorityConfigurations is required.")]
[JsonProperty(PropertyName = "jobPriorityConfigurations")]
public List<JobPriorityConfiguration> JobPriorityConfigurations { get; set; }
Property Value
Type Description
List<JobPriorityConfiguration>

List of job priority configurations related to the batch context.

Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

A message that describes the current state in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public BatchContext.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
BatchContext.LifecycleStateEnum?

The current state of the batch context.

Remarks

Required

LoggingConfiguration

Declaration
[JsonProperty(PropertyName = "loggingConfiguration")]
public LoggingConfiguration LoggingConfiguration { get; set; }
Property Value
Type Description
LoggingConfiguration

Network

Declaration
[Required(ErrorMessage = "Network is required.")]
[JsonProperty(PropertyName = "network")]
public Network Network { get; set; }
Property Value
Type Description
Network
Remarks

Required

SystemTags

Declaration
[Required(ErrorMessage = "SystemTags is required.")]
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the batch context was created, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time the batch context was updated, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z

In this article
Back to top