Class BatchJob

A batch job represents the execution unit that is invoked on a batch's pools of compute resources. A job is composed of one or more tasks, which are the executable commands.
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

BatchJob

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 BatchJob

Properties

BatchContextId

Declaration

[Required(ErrorMessage = "BatchContextId is required.")]
[JsonProperty(PropertyName = "batchContextId")]
public string BatchContextId { get; set; }

Property Value

Type	Description
string	The OCID of the parent batch context of the parent job pool.

Remarks

Required

BatchJobPoolId

Declaration

[Required(ErrorMessage = "BatchJobPoolId is required.")]
[JsonProperty(PropertyName = "batchJobPoolId")]
public string BatchJobPoolId { get; set; }

Property Value

Type	Description
string	The OCID of the parent batch job pool.

Remarks

Required

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	An optional description that provides additional context next to the displayName.

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

EnvironmentVariables

Declaration

[JsonProperty(PropertyName = "environmentVariables")]
public List<EnvironmentVariable> EnvironmentVariables { get; set; }

Property Value

Type	Description
List<EnvironmentVariable>	An environment variables to use for the job's tasks (can be overridden by task's environment variables).

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 job.

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message that describes the current state of the batch job 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 BatchJob.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
BatchJob.LifecycleStateEnum?	The current state of the batch job.

Remarks

Required

Priority

Declaration

[JsonProperty(PropertyName = "priority")]
public int? Priority { get; set; }

Property Value

Type	Description
int?	A value calculated by the system based on the priority tags.

ProgressDetails

Declaration

[JsonProperty(PropertyName = "progressDetails")]
public string ProgressDetails { get; set; }

Property Value

Type	Description
string	A more detailed textual representation of the job completion.

ProgressPercentage

Declaration

[JsonProperty(PropertyName = "progressPercentage")]
public int? ProgressPercentage { get; set; }

Property Value

Type	Description
int?	A percentage value (0..100) of the job completion.

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 job 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 job was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z