Class BatchTaskSummary

Summary information about a batch task.

Inheritance

object

BatchTaskSummary

ComputeTaskSummary

GroupTaskSummary

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(BatchTaskSummaryModelConverter))]
public class BatchTaskSummary

Properties

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.

GroupTaskName

Declaration

[JsonProperty(PropertyName = "groupTaskName")]
public string GroupTaskName { get; set; }

Property Value

Type	Description
string	The hierarchical name of the group task. Null for top-level tasks.

HierarchicalName

Declaration

[JsonProperty(PropertyName = "hierarchicalName")]
public string HierarchicalName { get; set; }

Property Value

Type	Description
string	The hierarchical name of the task, which incorporates names of all parent group tasks, separated by "." (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName

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

JobId

Declaration

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

Property Value

Type	Description
string	The OCID of the batch job to which this task belongs.

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(StringEnumConverter))]
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