jobs

Creates, updates, deletes, gets or lists a jobs resource.

Overview

Name	jobs
Type	Resource
Id	google.run.jobs

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
annotations	object	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.
binaryAuthorization	object	Settings for the Binary Authorization feature. (id: GoogleCloudRunV2BinaryAuthorization)
client	string	Arbitrary identifier for the API client.
clientVersion	string	Arbitrary version identifier for the API client.
conditions	array	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.
createTime	string (google-datetime)	Output only. The creation time.
creator	string	Output only. Email address of the authenticated creator.
deleteTime	string (google-datetime)	Output only. The deletion time. It is only populated as a response to a Delete request.
etag	string	Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
executionCount	integer (int32)	Output only. Number of executions created for this job.
expireTime	string (google-datetime)	Output only. For a deleted resource, the time after which it will be permamently deleted.
generation	string (int64)	Output only. A number that monotonically increases every time the user modifies the desired state.
labels	object	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.
lastModifier	string	Output only. Email address of the last authenticated modifier.
latestCreatedExecution	object	Output only. Name of the last created execution. (id: GoogleCloudRunV2ExecutionReference)
launchStage	string	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.
observedGeneration	string (int64)	Output only. The generation of this Job. See comments in reconciling for additional information on reconciliation process in Cloud Run.
reconciling	boolean	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.
runExecutionToken	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.
satisfiesPzs	boolean	Output only. Reserved for future use.
startExecutionToken	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.
template	object	Required. The template used to create executions for this Job. (id: GoogleCloudRunV2ExecutionTemplate)
terminalCondition	object	Defines a status condition for a resource. (id: GoogleCloudRunV2Condition)
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.
updateTime	string (google-datetime)	Output only. The last-modified time.

list

Successful response

Name	Datatype	Description
name	string	The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
annotations	object	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.
binaryAuthorization	object	Settings for the Binary Authorization feature. (id: GoogleCloudRunV2BinaryAuthorization)
client	string	Arbitrary identifier for the API client.
clientVersion	string	Arbitrary version identifier for the API client.
conditions	array	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.
createTime	string (google-datetime)	Output only. The creation time.
creator	string	Output only. Email address of the authenticated creator.
deleteTime	string (google-datetime)	Output only. The deletion time. It is only populated as a response to a Delete request.
etag	string	Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
executionCount	integer (int32)	Output only. Number of executions created for this job.
expireTime	string (google-datetime)	Output only. For a deleted resource, the time after which it will be permamently deleted.
generation	string (int64)	Output only. A number that monotonically increases every time the user modifies the desired state.
labels	object	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.
lastModifier	string	Output only. Email address of the last authenticated modifier.
latestCreatedExecution	object	Output only. Name of the last created execution. (id: GoogleCloudRunV2ExecutionReference)
launchStage	string	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.
observedGeneration	string (int64)	Output only. The generation of this Job. See comments in reconciling for additional information on reconciliation process in Cloud Run.
reconciling	boolean	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.
runExecutionToken	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.
satisfiesPzs	boolean	Output only. Reserved for future use.
startExecutionToken	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.
template	object	Required. The template used to create executions for this Job. (id: GoogleCloudRunV2ExecutionTemplate)
terminalCondition	object	Defines a status condition for a resource. (id: GoogleCloudRunV2Condition)
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.
updateTime	string (google-datetime)	Output only. The last-modified time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, jobsId		Gets information about a Job.
list	select	projectsId, locationsId	pageSize, pageToken, showDeleted	Lists Jobs. Results are sorted by creation time, descending.
create	insert	projectsId, locationsId	jobId, validateOnly	Creates a Job.
patch	update	projectsId, locationsId, jobsId	validateOnly, allowMissing	Updates a Job.
delete	delete	projectsId, locationsId, jobsId	validateOnly, etag	Deletes a Job.
run	exec	projectsId, locationsId, jobsId		Triggers creation of a new Execution of this Job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
jobsId	string
locationsId	string
projectsId	string
allowMissing	boolean
etag	string
jobId	string
pageSize	integer (int32)
pageToken	string
showDeleted	boolean
validateOnly	boolean

SELECT examples

get

Gets information about a Job.

SELECT
name,
annotations,
binaryAuthorization,
client,
clientVersion,
conditions,
createTime,
creator,
deleteTime,
etag,
executionCount,
expireTime,
generation,
labels,
lastModifier,
latestCreatedExecution,
launchStage,
observedGeneration,
reconciling,
runExecutionToken,
satisfiesPzs,
startExecutionToken,
template,
terminalCondition,
uid,
updateTime
FROM google.run.jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND jobsId = '{{ jobsId }}' -- required;

list

Lists Jobs. Results are sorted by creation time, descending.

SELECT
name,
annotations,
binaryAuthorization,
client,
clientVersion,
conditions,
createTime,
creator,
deleteTime,
etag,
executionCount,
expireTime,
generation,
labels,
lastModifier,
latestCreatedExecution,
launchStage,
observedGeneration,
reconciling,
runExecutionToken,
satisfiesPzs,
startExecutionToken,
template,
terminalCondition,
uid,
updateTime
FROM google.run.jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND showDeleted = '{{ showDeleted }}';

INSERT examples

create

Creates a Job.

INSERT INTO google.run.jobs (
data__name,
data__labels,
data__annotations,
data__client,
data__clientVersion,
data__launchStage,
data__binaryAuthorization,
data__template,
data__startExecutionToken,
data__runExecutionToken,
data__etag,
projectsId,
locationsId,
jobId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ annotations }}',
'{{ client }}',
'{{ clientVersion }}',
'{{ launchStage }}',
'{{ binaryAuthorization }}',
'{{ template }}',
'{{ startExecutionToken }}',
'{{ runExecutionToken }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ jobId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: jobs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the jobs resource.
    - name: locationsId
      value: string
      description: Required parameter for the jobs resource.
    - name: name
      value: string
      description: >
        The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
        
    - name: labels
      value: object
      description: >
        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.
        
    - name: annotations
      value: object
      description: >
        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.
        
    - name: client
      value: string
      description: >
        Arbitrary identifier for the API client.
        
    - name: clientVersion
      value: string
      description: >
        Arbitrary version identifier for the API client.
        
    - name: launchStage
      value: string
      description: >
        The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/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.
        
      valid_values: ['LAUNCH_STAGE_UNSPECIFIED', 'UNIMPLEMENTED', 'PRELAUNCH', 'EARLY_ACCESS', 'ALPHA', 'BETA', 'GA', 'DEPRECATED']
    - name: binaryAuthorization
      value: object
      description: >
        Settings for the Binary Authorization feature.
        
    - name: template
      value: object
      description: >
        Required. The template used to create executions for this Job.
        
    - name: startExecutionToken
      value: string
      description: >
        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.
        
    - name: runExecutionToken
      value: string
      description: >
        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.
        
    - name: etag
      value: string
      description: >
        Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
        
    - name: jobId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Updates a Job.

UPDATE google.run.jobs
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}',
data__client = '{{ client }}',
data__clientVersion = '{{ clientVersion }}',
data__launchStage = '{{ launchStage }}',
data__binaryAuthorization = '{{ binaryAuthorization }}',
data__template = '{{ template }}',
data__startExecutionToken = '{{ startExecutionToken }}',
data__runExecutionToken = '{{ runExecutionToken }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND jobsId = '{{ jobsId }}' --required
AND validateOnly = {{ validateOnly}}
AND allowMissing = {{ allowMissing}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a Job.

DELETE FROM google.run.jobs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND jobsId = '{{ jobsId }}' --required
AND validateOnly = '{{ validateOnly }}'
AND etag = '{{ etag }}';

Lifecycle Methods

run

Triggers creation of a new Execution of this Job.

EXEC google.run.jobs.run 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@jobsId='{{ jobsId }}' --required 
@@json=
'{
"validateOnly": {{ validateOnly }}, 
"etag": "{{ etag }}", 
"overrides": "{{ overrides }}"
}';