Google Cloud Run V2 Client - Class Execution (0.4.0)

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

Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The unique name of this Execution.
`↳ uid`	`string` Output only. Server assigned unique identifier for the Execution. 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 execution was acknowledged by the execution 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 execution 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 execution 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.
`↳ launch_stage`	`int` The least stable launch stage needed to create this resource, as defined by Google Cloud Platform Launch Stages. Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA.
`↳ job`	`string` Output only. The name of the parent Job.
`↳ parallelism`	`int` Output only. Specifies the maximum desired number of tasks the execution should run at any given time. Must be <= task_count. The actual number of tasks running in steady state will be less than this number when ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism.
`↳ task_count`	`int` Output only. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution.
`↳ template`	`Google\Cloud\Run\V2\TaskTemplate` Output only. The template used to create tasks for this execution.
`↳ 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 Execution, 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 Execution. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
`↳ running_count`	`int` Output only. The number of actively running tasks.
`↳ succeeded_count`	`int` Output only. The number of tasks which reached phase Succeeded.
`↳ failed_count`	`int` Output only. The number of tasks which reached phase Failed.
`↳ cancelled_count`	`int` Output only. The number of tasks which reached phase Cancelled.
`↳ retried_count`	`int` Output only. The number of tasks which have retried at least once.
`↳ 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 Execution.

Returns
Type	Description
`string`

setName

Output only. The unique name of this Execution.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

Output only. Server assigned unique identifier for the Execution. 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 Execution. 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 execution was acknowledged by the execution controller. 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 execution was acknowledged by the execution controller. 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 execution 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 execution 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 execution 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 execution 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`

getLaunchStage

The least stable launch stage needed to create this resource, as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA.

Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA.

Returns
Type	Description
`int`

setLaunchStage

The least stable launch stage needed to create this resource, as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA.

Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA.

Parameter
Name	Description
`var`	`int`

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`

getParallelism

Output only. Specifies the maximum desired number of tasks the execution should run at any given time. Must be <= task_count. The actual number of tasks running in steady state will be less than this number when ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism.

Returns
Type	Description
`int`

setParallelism

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getTaskCount

Output only. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution.

Returns
Type	Description
`int`

setTaskCount

Output only. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getTemplate

Output only. The template used to create tasks for this execution.

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

hasTemplate

clearTemplate

setTemplate

Output only. The template used to create tasks for this execution.

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

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 Execution, 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 Execution, 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 Execution. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Returns
Type	Description
`int\|string`

setObservedGeneration

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

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

Returns
Type	Description
`$this`

getRunningCount

Output only. The number of actively running tasks.

Returns
Type	Description
`int`

setRunningCount

Output only. The number of actively running tasks.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSucceededCount

Output only. The number of tasks which reached phase Succeeded.

Returns
Type	Description
`int`

setSucceededCount

Output only. The number of tasks which reached phase Succeeded.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getFailedCount

Output only. The number of tasks which reached phase Failed.

Returns
Type	Description
`int`

setFailedCount

Output only. The number of tasks which reached phase Failed.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getCancelledCount

Output only. The number of tasks which reached phase Cancelled.

Returns
Type	Description
`int`

setCancelledCount

Output only. The number of tasks which reached phase Cancelled.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRetriedCount

Output only. The number of tasks which have retried at least once.

Returns
Type	Description
`int`

setRetriedCount

Output only. The number of tasks which have retried at least once.

Parameter
Name	Description
`var`	`int`

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`