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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ runnables |
array<Google\Cloud\Batch\V1\Runnable>
The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures. |
↳ compute_resource |
Google\Cloud\Batch\V1\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 |
↳ 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<Google\Cloud\Batch\V1\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<Google\Cloud\Batch\V1\Volume>
Volumes to mount before running Tasks using this TaskSpec. |
↳ environment |
Google\Cloud\Batch\V1\Environment
Environment variables to set before running the Task. |
getRunnables
The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag.
Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setRunnables
The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag.
Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Batch\V1\Runnable>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComputeResource
ComputeResource requirements.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\ComputeResource|null |
|
hasComputeResource
clearComputeResource
setComputeResource
ComputeResource requirements.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\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<Google\Cloud\Batch\V1\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<Google\Cloud\Batch\V1\Volume>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnvironment
Environment variables to set before running the Task.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\Environment|null |
|
hasEnvironment
clearEnvironment
setEnvironment
Environment variables to set before running the Task.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\Environment
|
| Returns | |
|---|---|
| Type | Description |
$this |
|