Google Cloud Run V2 Client - Class Task (1.3.0)

Reference documentation and code samples for the Google Cloud Run V2 Client class Task.

Task represents a single run of a container to completion.

Generated from protobuf message google.cloud.run.v2.Task

Namespace

Google \ Cloud \ Run \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The unique name of this Task.
`↳ uid`	`string` Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
`↳ generation`	`int\|string` Output only. A number that monotonically increases every time the user modifies the desired state.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels
`↳ annotations`	`array\|Google\Protobuf\Internal\MapField` Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Represents time when the task was created by the system. It is not guaranteed to be set in happens-before order across separate operations.
`↳ scheduled_time`	`Google\Protobuf\Timestamp` Output only. Represents time when the task was scheduled to run by the system. It is not guaranteed to be set in happens-before order across separate operations.
`↳ start_time`	`Google\Protobuf\Timestamp` Output only. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations.
`↳ completion_time`	`Google\Protobuf\Timestamp` Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The last-modified time.
`↳ delete_time`	`Google\Protobuf\Timestamp` Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
`↳ expire_time`	`Google\Protobuf\Timestamp` Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.
`↳ job`	`string` Output only. The name of the parent Job.
`↳ execution`	`string` Output only. The name of the parent Execution.
`↳ containers`	`array<Google\Cloud\Run\V2\Container>` Holds the single container that defines the unit of execution for this task.
`↳ volumes`	`array<Google\Cloud\Run\V2\Volume>` A list of Volumes to make available to containers.
`↳ max_retries`	`int` Number of retries allowed per Task, before marking this Task failed.
`↳ timeout`	`Google\Protobuf\Duration` Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
`↳ service_account`	`string` Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.
`↳ execution_environment`	`int` The execution environment being used to host this Task.
`↳ reconciling`	`bool` Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
`↳ conditions`	`array<Google\Cloud\Run\V2\Condition>` Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state.
`↳ observed_generation`	`int\|string` Output only. The generation of this Task. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
`↳ index`	`int` Output only. Index of the Task, unique per execution, and beginning at 0.
`↳ retried`	`int` Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit.
`↳ last_attempt_result`	`Google\Cloud\Run\V2\TaskAttemptResult` Output only. Result of the last attempt of this Task.
`↳ encryption_key`	`string` Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
`↳ vpc_access`	`Google\Cloud\Run\V2\VpcAccess` Output only. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
`↳ log_uri`	`string` Output only. URI where logs for this execution can be found in Cloud Console.
`↳ satisfies_pzs`	`bool` Output only. Reserved for future use.
`↳ etag`	`string` Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

getName

Output only. The unique name of this Task.

Returns
Type	Description
`string`

setName

Output only. The unique name of this Task.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

Returns
Type	Description
`string`

setUid

Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGeneration

Output only. A number that monotonically increases every time the user modifies the desired state.

Returns
Type	Description
`int\|string`

setGeneration

Output only. A number that monotonically increases every time the user modifies the desired state.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getLabels

Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getAnnotations

Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata.

They are not queryable and should be preserved when modifying objects.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setAnnotations

Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata.

They are not queryable and should be preserved when modifying objects.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCreateTime

Output only. Represents time when the task was created by the system.

It is not guaranteed to be set in happens-before order across separate operations.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Represents time when the task was created by the system.

It is not guaranteed to be set in happens-before order across separate operations.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getScheduledTime

Output only. Represents time when the task was scheduled to run by the system. It is not guaranteed to be set in happens-before order across separate operations.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasScheduledTime

clearScheduledTime

setScheduledTime

Output only. Represents time when the task was scheduled to run by the system. It is not guaranteed to be set in happens-before order across separate operations.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getStartTime

Output only. Represents time when the task started to run.

It is not guaranteed to be set in happens-before order across separate operations.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

Output only. Represents time when the task started to run.

It is not guaranteed to be set in happens-before order across separate operations.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getCompletionTime

Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCompletionTime

clearCompletionTime

setCompletionTime

Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The last-modified time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last-modified time.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDeleteTime

Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getExpireTime

Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasExpireTime

clearExpireTime

setExpireTime

Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getJob

Output only. The name of the parent Job.

Returns
Type	Description
`string`

setJob

Output only. The name of the parent Job.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getExecution

Output only. The name of the parent Execution.

Returns
Type	Description
`string`

setExecution

Output only. The name of the parent Execution.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getContainers

Holds the single container that defines the unit of execution for this task.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setContainers

Holds the single container that defines the unit of execution for this task.

Parameter
Name	Description
`var`	`array<Google\Cloud\Run\V2\Container>`

Returns
Type	Description
`$this`

getVolumes

A list of Volumes to make available to containers.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setVolumes

A list of Volumes to make available to containers.

Parameter
Name	Description
`var`	`array<Google\Cloud\Run\V2\Volume>`

Returns
Type	Description
`$this`

getMaxRetries

Number of retries allowed per Task, before marking this Task failed.

Returns
Type	Description
`int`

setMaxRetries

Number of retries allowed per Task, before marking this Task failed.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getTimeout

Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasTimeout

clearTimeout

setTimeout

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

getServiceAccount

Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.

Returns
Type	Description
`string`

setServiceAccount

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getExecutionEnvironment

The execution environment being used to host this Task.

Returns
Type	Description
`int`

setExecutionEnvironment

The execution environment being used to host this Task.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getReconciling

Output only. Indicates whether the resource's reconciliation is still in progress. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run.

Returns
Type	Description
`bool`

setReconciling

Output only. Indicates whether the resource's reconciliation is still in progress. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getConditions

Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setConditions

Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state.

Parameter
Name	Description
`var`	`array<Google\Cloud\Run\V2\Condition>`

Returns
Type	Description
`$this`

getObservedGeneration

Output only. The generation of this Task. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run.

Returns
Type	Description
`int\|string`

setObservedGeneration

Output only. The generation of this Task. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getIndex

Output only. Index of the Task, unique per execution, and beginning at 0.

Returns
Type	Description
`int`

setIndex

Output only. Index of the Task, unique per execution, and beginning at 0.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRetried

Output only. The number of times this Task was retried.

Tasks are retried when they fail up to the maxRetries limit.

Returns
Type	Description
`int`

setRetried

Output only. The number of times this Task was retried.

Tasks are retried when they fail up to the maxRetries limit.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getLastAttemptResult

Output only. Result of the last attempt of this Task.

Returns
Type	Description
`Google\Cloud\Run\V2\TaskAttemptResult\|null`

hasLastAttemptResult

clearLastAttemptResult

setLastAttemptResult

Output only. Result of the last attempt of this Task.

Parameter
Name	Description
`var`	`Google\Cloud\Run\V2\TaskAttemptResult`

Returns
Type	Description
`$this`

getEncryptionKey

Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek

Returns
Type	Description
`string`

setEncryptionKey

Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVpcAccess

Output only. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

Returns
Type	Description
`Google\Cloud\Run\V2\VpcAccess\|null`

hasVpcAccess

clearVpcAccess

setVpcAccess

Output only. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

Parameter
Name	Description
`var`	`Google\Cloud\Run\V2\VpcAccess`

Returns
Type	Description
`$this`

getLogUri

Output only. URI where logs for this execution can be found in Cloud Console.

Returns
Type	Description
`string`

setLogUri

Output only. URI where logs for this execution can be found in Cloud Console.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSatisfiesPzs

Output only. Reserved for future use.

Returns
Type	Description
`bool`

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEtag

Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

Returns
Type	Description
`string`

setEtag

Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`