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 \ V2Methods
__construct
Constructor.
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
↳ update_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
↳ template
↳ 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
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< 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
↳ 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}
string
setName
The fully qualified name of this Job.
Format: projects/{project}/locations/{location}/jobs/{job}
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
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.
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.
$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.
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.
$this
getCreateTime
Output only. The creation time.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation time.
$this
getUpdateTime
Output only. The last-modified time.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last-modified time.
$this
getDeleteTime
Output only. The deletion time. It is only populated as a response to a Delete request.
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. 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.
hasExpireTime
clearExpireTime
setExpireTime
Output only. For a deleted resource, the time after which it will be permamently deleted.
$this
getCreator
Output only. Email address of the authenticated creator.
string
setCreator
Output only. Email address of the authenticated creator.
var
string
$this
getLastModifier
Output only. Email address of the last authenticated modifier.
string
setLastModifier
Output only. Email address of the last authenticated modifier.
var
string
$this
getClient
Arbitrary identifier for the API client.
string
setClient
Arbitrary identifier for the API client.
var
string
$this
getClientVersion
Arbitrary version identifier for the API client.
string
setClientVersion
Arbitrary version identifier for the API client.
var
string
$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.
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.
var
int
$this
getBinaryAuthorization
Settings for the Binary Authorization feature.
hasBinaryAuthorization
clearBinaryAuthorization
setBinaryAuthorization
Settings for the Binary Authorization feature.
$this
getTemplate
Required. The template used to create executions for this Job.
hasTemplate
clearTemplate
setTemplate
Required. The template used to create executions for this Job.
$this
getObservedGeneration
Output only. The generation of this Job. See comments in reconciling
for
additional information on reconciliation process in Cloud Run.
int|string
setObservedGeneration
Output only. The generation of this Job. See comments in reconciling
for
additional information on reconciliation process in Cloud Run.
var
int|string
$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.
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.
$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.
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.
$this
getExecutionCount
Output only. Number of executions created for this job.
int
setExecutionCount
Output only. Number of executions created for this job.
var
int
$this
getLatestCreatedExecution
Output only. Name of the last created execution.
hasLatestCreatedExecution
clearLatestCreatedExecution
setLatestCreatedExecution
Output only. Name of the last created execution.
$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
.
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
.
var
bool
$this
getSatisfiesPzs
Output only. Reserved for future use.
bool
setSatisfiesPzs
Output only. Reserved for future use.
var
bool
$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.
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.
var
string
$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.
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.
var
string
$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
getCreateExecution
string