Batch v1 API - Class TaskSpec (2.12.0)

public sealed class TaskSpec : IMessage<TaskSpec>, IEquatable<TaskSpec>, IDeepCloneable<TaskSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Batch v1 API class TaskSpec.

Spec of a task

Inheritance

object > TaskSpec

Namespace

Google.Cloud.Batch.V1

Assembly

Google.Cloud.Batch.V1.dll

Constructors

TaskSpec()

public TaskSpec()

TaskSpec(TaskSpec)

public TaskSpec(TaskSpec other)
Parameter
Name Description
other TaskSpec

Properties

ComputeResource

public ComputeResource ComputeResource { get; set; }

ComputeResource requirements.

Property Value
Type Description
ComputeResource

Environment

public Environment Environment { get; set; }

Environment variables to set before running the Task.

Property Value
Type Description
Environment

Environments

[Obsolete]
public MapField<string, string> Environments { get; }

Deprecated: please use environment(non-plural) instead.

Property Value
Type Description
MapFieldstringstring

LifecyclePolicies

public RepeatedField<LifecyclePolicy> LifecyclePolicies { get; }

Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.

Property Value
Type Description
RepeatedFieldLifecyclePolicy

MaxRetryCount

public int MaxRetryCount { get; set; }

Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].

Property Value
Type Description
int

MaxRunDuration

public Duration MaxRunDuration { get; set; }

Maximum duration the task should run before being automatically retried (if enabled) or automatically failed. Format the value of this field as a time limit in seconds followed by s&mdash;for example, 3600s for 1 hour. The field accepts any value between 0 and the maximum listed for the Duration field type at https://protobuf.dev/reference/protobuf/google.protobuf/#duration; however, the actual maximum run time for a job will be limited to the maximum run time for a job listed at https://cloud.google.com/batch/quotas#max-job-duration.

Property Value
Type Description
Duration

Runnables

public RepeatedField<Runnable> Runnables { get; }

Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must meet at least one of the following conditions:

  • The runnable exited with a zero status.
  • The runnable didn't finish, but you enabled its background subfield.
  • The runnable exited with a non-zero status, but you enabled its ignore_exit_status subfield.
Property Value
Type Description
RepeatedFieldRunnable

Volumes

public RepeatedField<Volume> Volumes { get; }

Volumes to mount before running Tasks using this TaskSpec.

Property Value
Type Description
RepeatedFieldVolume