Google Cloud Batch V1 Client - Class TaskSpec (1.1.3)

Reference documentation and code samples for the Google Cloud Batch V1 Client class TaskSpec.

Spec of a task

Generated from protobuf message google.cloud.batch.v1.TaskSpec

Namespace

Google \ Cloud \ Batch \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ runnables array<Runnable>

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.
↳ compute_resource ComputeResource

ComputeResource requirements.
↳ max_run_duration Google\Protobuf\Duration

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—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.
↳ max_retry_count int

Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
↳ lifecycle_policies array<LifecyclePolicy>

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.
↳ environments array|Google\Protobuf\Internal\MapField

Deprecated: please use environment(non-plural) instead.
↳ volumes array<Volume>

Volumes to mount before running Tasks using this TaskSpec.
↳ environment Environment

Environment variables to set before running the Task.

getRunnables

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.
Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRunnables

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.
Parameter
Name Description
var array<Runnable>
Returns
Type Description
$this

getComputeResource

ComputeResource requirements.

Returns
Type Description
ComputeResource|null

hasComputeResource

clearComputeResource

setComputeResource

ComputeResource requirements.

Parameter
Name Description
var ComputeResource
Returns
Type Description
$this

getMaxRunDuration

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

Returns
Type Description
Google\Protobuf\Duration|null

hasMaxRunDuration

clearMaxRunDuration

setMaxRunDuration

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

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getMaxRetryCount

Maximum number of retries on failures.

The default, 0, which means never retry. The valid value range is [0, 10].

Returns
Type Description
int

setMaxRetryCount

Maximum number of retries on failures.

The default, 0, which means never retry. The valid value range is [0, 10].

Parameter
Name Description
var int
Returns
Type Description
$this

getLifecyclePolicies

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setLifecyclePolicies

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.

Parameter
Name Description
var array<LifecyclePolicy>
Returns
Type Description
$this

getEnvironments

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

Returns
Type Description
Google\Protobuf\Internal\MapField

setEnvironments

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getVolumes

Volumes to mount before running Tasks using this TaskSpec.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setVolumes

Volumes to mount before running Tasks using this TaskSpec.

Parameter
Name Description
var array<Volume>
Returns
Type Description
$this

getEnvironment

Environment variables to set before running the Task.

Returns
Type Description
Environment|null

hasEnvironment

clearEnvironment

setEnvironment

Environment variables to set before running the Task.

Parameter
Name Description
var Environment
Returns
Type Description
$this