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.
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
↳ 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
↳ 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.
string
setName
Output only. The unique name of this Execution.
var
string
$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.
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.
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 execution was acknowledged by the execution controller. It is not guaranteed to be set in happens-before order across separate operations.
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.
$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.
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.
$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.
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.
$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
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.
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.
var
int
$this
getJob
Output only. The name of the parent Job.
string
setJob
Output only. The name of the parent Job.
var
string
$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.
int
setParallelism
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.
var
int
$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.
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.
var
int
$this
getTemplate
Output only. The template used to create tasks for this execution.
hasTemplate
clearTemplate
setTemplate
Output only. The template used to create tasks for this execution.
$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 Execution, containing its readiness status, and detailed error information in case it did not reach the desired state.
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.
$this
getObservedGeneration
Output only. The generation of this Execution. See comments in reconciling
for additional information on reconciliation process in Cloud
Run.
int|string
setObservedGeneration
Output only. The generation of this Execution. See comments in reconciling
for additional information on reconciliation process in Cloud
Run.
var
int|string
$this
getRunningCount
Output only. The number of actively running tasks.
int
setRunningCount
Output only. The number of actively running tasks.
var
int
$this
getSucceededCount
Output only. The number of tasks which reached phase Succeeded.
int
setSucceededCount
Output only. The number of tasks which reached phase Succeeded.
var
int
$this
getFailedCount
Output only. The number of tasks which reached phase Failed.
int
setFailedCount
Output only. The number of tasks which reached phase Failed.
var
int
$this
getCancelledCount
Output only. The number of tasks which reached phase Cancelled.
int
setCancelledCount
Output only. The number of tasks which reached phase Cancelled.
var
int
$this
getRetriedCount
Output only. The number of tasks which have retried at least once.
int
setRetriedCount
Output only. The number of tasks which have retried at least once.
var
int
$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
