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
Methods
__construct
Constructor.
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 job controller. 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
↳ 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
↳ 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
↳ 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.
string
setName
Output only. The unique name of this Task.
var
string
$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.
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.
var
string
$this
getGeneration
Output only. A number that monotonically increases every time the user modifies the desired state.
int|string
setGeneration
Output only. A number that monotonically increases every time the user modifies the desired state.
var
int|string
$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
setLabels
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
$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.
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.
$this
getCreateTime
Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations.
$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.
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.
$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.
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.
$this
getUpdateTime
Output only. The last-modified time.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last-modified time.
$this
getDeleteTime
Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
$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.
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.
$this
getJob
Output only. The name of the parent Job.
string
setJob
Output only. The name of the parent Job.
var
string
$this
getExecution
Output only. The name of the parent Execution.
string
setExecution
Output only. The name of the parent Execution.
var
string
$this
getContainers
Holds the single container that defines the unit of execution for this task.
setContainers
Holds the single container that defines the unit of execution for this task.
$this
getVolumes
A list of Volumes to make available to containers.
setVolumes
A list of Volumes to make available to containers.
$this
getMaxRetries
Number of retries allowed per Task, before marking this Task failed.
int
setMaxRetries
Number of retries allowed per Task, before marking this Task failed.
var
int
$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.
hasTimeout
clearTimeout
setTimeout
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.
$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.
string
setServiceAccount
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.
var
string
$this
getExecutionEnvironment
The execution environment being used to host this Task.
int
setExecutionEnvironment
The execution environment being used to host this Task.
var
int
$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.
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.
var
bool
$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.
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.
$this
getObservedGeneration
Output only. The generation of this Task. See comments in Job.reconciling
for additional information on reconciliation process in Cloud Run.
int|string
setObservedGeneration
Output only. The generation of this Task. See comments in Job.reconciling
for additional information on reconciliation process in Cloud Run.
var
int|string
$this
getIndex
Output only. Index of the Task, unique per execution, and beginning at 0.
int
setIndex
Output only. Index of the Task, unique per execution, and beginning at 0.
var
int
$this
getRetried
Output only. The number of times this Task was retried.
Tasks are retried when they fail up to the maxRetries limit.
int
setRetried
Output only. The number of times this Task was retried.
Tasks are retried when they fail up to the maxRetries limit.
var
int
$this
getLastAttemptResult
Output only. Result of the last attempt of this Task.
hasLastAttemptResult
clearLastAttemptResult
setLastAttemptResult
Output only. Result of the last attempt of this Task.
$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
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
var
string
$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 .
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 .
$this
getLogUri
Output only. URI where logs for this execution can be found in Cloud Console.
string
setLogUri
Output only. URI where logs for this execution can be found in Cloud Console.
var
string
$this
getSatisfiesPzs
Output only. Reserved for future use.
bool
setSatisfiesPzs
Output only. Reserved for future use.
var
bool
$this
getEtag
Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string
setEtag
Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
var
string
$this
