Show / Hide Table of Contents

Class BatchTask

A batch task contains common properties for all types of job tasks.

Inheritance
object
BatchTask
ComputeTask
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
[JsonConverter(typeof(BatchTaskModelConverter))]
public class BatchTask

Properties

Dependencies

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

A list of tasks from the same job this task depends on referenced by name.

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.

EntitlementClaims

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

A list of resources (for example licences) this task needs for its execution.

Remarks

Required

EnvironmentVariables

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

Environment variables to use for the task execution.

Remarks

Required

Id

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

The UUID of batch task.

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 task in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

LifecycleState

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

The current state of the batch task.

Name

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

The name of the batch task. It must be unique within its parent batch job.

Remarks

Required

In this article
Back to top