Google Cloud Run V2 Client - Class Job (1.3.0)

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

Job represents the configuration of a single job, which references a container image that is run to completion.

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

Namespace

Google \ Cloud \ Run \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
↳ 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

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.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job.
↳ annotations array|Google\Protobuf\Internal\MapField

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.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job.

This field follows Kubernetes annotations' namespacing, limits, and rules.
↳ create_time Google\Protobuf\Timestamp

Output only. The creation time.
↳ update_time Google\Protobuf\Timestamp

Output only. The last-modified time.
↳ delete_time Google\Protobuf\Timestamp

Output only. 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.
↳ creator string

Output only. Email address of the authenticated creator.
↳ last_modifier string

Output only. Email address of the last authenticated modifier.
↳ client string

Arbitrary identifier for the API client.
↳ client_version string

Arbitrary version identifier for the API client.
↳ launch_stage int

The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
↳ binary_authorization Google\Cloud\Run\V2\BinaryAuthorization

Settings for the Binary Authorization feature.
↳ template Google\Cloud\Run\V2\ExecutionTemplate

Required. The template used to create executions for this Job.
↳ observed_generation int|string

Output only. The generation of this Job. See comments in reconciling for additional information on reconciliation process in Cloud Run.
↳ terminal_condition Google\Cloud\Run\V2\Condition

Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
↳ conditions array<Google\Cloud\Run\V2\Condition>

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
↳ execution_count int

Output only. Number of executions created for this job.
↳ latest_created_execution Google\Cloud\Run\V2\ExecutionReference

Output only. Name of the last created execution.
↳ reconciling bool

Output only. Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, observed_generation and latest_succeeded_execution, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: observed_generation and generation, latest_succeeded_execution and latest_created_execution. If reconciliation failed, observed_generation and latest_succeeded_execution will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in terminal_condition and conditions.
↳ satisfies_pzs bool

Output only. Reserved for future use.
↳ start_execution_token string

A unique string used as a suffix creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters.
↳ run_execution_token string

A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed. The sum of job name and token length must be fewer than 63 characters.
↳ etag string

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

getName

The fully qualified name of this Job.

Format: projects/{project}/locations/{location}/jobs/{job}

Returns
Type Description
string

setName

The fully qualified name of this Job.

Format: projects/{project}/locations/{location}/jobs/{job}

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

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.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

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.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getAnnotations

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.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job.

This field follows Kubernetes annotations' namespacing, limits, and rules.

Returns
Type Description
Google\Protobuf\Internal\MapField

setAnnotations

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.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job.

This field follows Kubernetes annotations' namespacing, limits, and rules.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getCreateTime

Output only. The creation time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

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. 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. 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.

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCreator

Output only. Email address of the authenticated creator.

Returns
Type Description
string

setCreator

Output only. Email address of the authenticated creator.

Parameter
Name Description
var string
Returns
Type Description
$this

getLastModifier

Output only. Email address of the last authenticated modifier.

Returns
Type Description
string

setLastModifier

Output only. Email address of the last authenticated modifier.

Parameter
Name Description
var string
Returns
Type Description
$this

getClient

Arbitrary identifier for the API client.

Returns
Type Description
string

setClient

Arbitrary identifier for the API client.

Parameter
Name Description
var string
Returns
Type Description
$this

getClientVersion

Arbitrary version identifier for the API client.

Returns
Type Description
string

setClientVersion

Arbitrary version identifier for the API client.

Parameter
Name Description
var string
Returns
Type Description
$this

getLaunchStage

The launch stage as defined by Google Cloud Platform Launch Stages.

Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

Returns
Type Description
int

setLaunchStage

The launch stage as defined by Google Cloud Platform Launch Stages.

Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

Parameter
Name Description
var int
Returns
Type Description
$this

getBinaryAuthorization

Settings for the Binary Authorization feature.

Returns
Type Description
Google\Cloud\Run\V2\BinaryAuthorization|null

hasBinaryAuthorization

clearBinaryAuthorization

setBinaryAuthorization

Settings for the Binary Authorization feature.

Parameter
Name Description
var Google\Cloud\Run\V2\BinaryAuthorization
Returns
Type Description
$this

getTemplate

Required. The template used to create executions for this Job.

Returns
Type Description
Google\Cloud\Run\V2\ExecutionTemplate|null

hasTemplate

clearTemplate

setTemplate

Required. The template used to create executions for this Job.

Parameter
Name Description
var Google\Cloud\Run\V2\ExecutionTemplate
Returns
Type Description
$this

getObservedGeneration

Output only. The generation of this Job. 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 Job. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTerminalCondition

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

Returns
Type Description
Google\Cloud\Run\V2\Condition|null

hasTerminalCondition

clearTerminalCondition

setTerminalCondition

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

Parameter
Name Description
var Google\Cloud\Run\V2\Condition
Returns
Type Description
$this

getConditions

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setConditions

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Parameter
Name Description
var array<Google\Cloud\Run\V2\Condition>
Returns
Type Description
$this

getExecutionCount

Output only. Number of executions created for this job.

Returns
Type Description
int

setExecutionCount

Output only. Number of executions created for this job.

Parameter
Name Description
var int
Returns
Type Description
$this

getLatestCreatedExecution

Output only. Name of the last created execution.

Returns
Type Description
Google\Cloud\Run\V2\ExecutionReference|null

hasLatestCreatedExecution

clearLatestCreatedExecution

setLatestCreatedExecution

Output only. Name of the last created execution.

Parameter
Name Description
var Google\Cloud\Run\V2\ExecutionReference
Returns
Type Description
$this

getReconciling

Output only. Returns true if the Job is currently being acted upon by the system to bring it into the desired state.

When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, observed_generation and latest_succeeded_execution, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: observed_generation and generation, latest_succeeded_execution and latest_created_execution. If reconciliation failed, observed_generation and latest_succeeded_execution will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in terminal_condition and conditions.

Returns
Type Description
bool

setReconciling

Output only. Returns true if the Job is currently being acted upon by the system to bring it into the desired state.

When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, observed_generation and latest_succeeded_execution, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: observed_generation and generation, latest_succeeded_execution and latest_created_execution. If reconciliation failed, observed_generation and latest_succeeded_execution will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in terminal_condition and conditions.

Parameter
Name Description
var bool
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

getStartExecutionToken

A unique string used as a suffix creating a new execution. The Job will become ready when the execution is successfully started.

The sum of job name and token length must be fewer than 63 characters.

Returns
Type Description
string

hasStartExecutionToken

setStartExecutionToken

A unique string used as a suffix creating a new execution. The Job will become ready when the execution is successfully started.

The sum of job name and token length must be fewer than 63 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getRunExecutionToken

A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed.

The sum of job name and token length must be fewer than 63 characters.

Returns
Type Description
string

hasRunExecutionToken

setRunExecutionToken

A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed.

The sum of job name and token length must be fewer than 63 characters.

Parameter
Name Description
var string
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

getCreateExecution

Returns
Type Description
string