jobs

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

Overview

Name	jobs
Type	Resource
Id	google.run.jobs

Fields

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 Binary Authorization feature.
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	Output only. The creation time.
creator	string	Output only. Email address of the authenticated creator.
deleteTime	string	Output only. The deletion time. It is only populated as a response to a Delete request.
etag	string	Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
executionCount	integer	Output only. Number of executions created for this job.
expireTime	string	Output only. For a deleted resource, the time after which it will be permamently deleted.
generation	string	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	Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.
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	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	ExecutionTemplate describes the data an execution should have when created from a template.
terminalCondition	object	Defines a status condition for a resource.
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	Output only. The last-modified time.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	jobsId, locationsId, projectsId	Gets information about a Job.
list	SELECT	locationsId, projectsId	Lists Jobs. Results are sorted by creation time, descending.
create	INSERT	locationsId, projectsId	Creates a Job.
delete	DELETE	jobsId, locationsId, projectsId	Deletes a Job.
patch	UPDATE	jobsId, locationsId, projectsId	Updates a Job.
run	EXEC	jobsId, locationsId, projectsId	Triggers creation of a new Execution of this Job.

SELECT examples

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 locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new jobs resource.

All Properties

/*+ create */
INSERT INTO google.run.jobs (
locationsId,
projectsId,
name,
labels,
annotations,
client,
clientVersion,
launchStage,
binaryAuthorization,
template,
startExecutionToken,
runExecutionToken
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ labels }}',
'{{ annotations }}',
'{{ client }}',
'{{ clientVersion }}',
'{{ launchStage }}',
'{{ binaryAuthorization }}',
'{{ template }}',
'{{ startExecutionToken }}',
'{{ runExecutionToken }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: uid
      value: string
    - name: generation
      value: string
    - name: labels
      value: object
    - name: annotations
      value: object
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: deleteTime
      value: string
    - name: expireTime
      value: string
    - name: creator
      value: string
    - name: lastModifier
      value: string
    - name: client
      value: string
    - name: clientVersion
      value: string
    - name: launchStage
      value: string
    - name: binaryAuthorization
      value:
        - name: useDefault
          value: boolean
        - name: policy
          value: string
        - name: breakglassJustification
          value: string
    - name: template
      value:
        - name: labels
          value: object
        - name: annotations
          value: object
        - name: parallelism
          value: integer
        - name: taskCount
          value: integer
        - name: template
          value:
            - name: containers
              value:
                - - name: name
                    value: string
                  - name: image
                    value: string
                  - name: command
                    value:
                      - string
                  - name: args
                    value:
                      - string
                  - name: env
                    value:
                      - - name: name
                          value: string
                        - name: value
                          value: string
                        - name: valueSource
                          value:
                            - name: secretKeyRef
                              value:
                                - name: secret
                                  value: string
                                - name: version
                                  value: string
                  - name: resources
                    value:
                      - name: limits
                        value: object
                      - name: cpuIdle
                        value: boolean
                      - name: startupCpuBoost
                        value: boolean
                  - name: ports
                    value:
                      - - name: name
                          value: string
                        - name: containerPort
                          value: integer
                  - name: volumeMounts
                    value:
                      - - name: name
                          value: string
                        - name: mountPath
                          value: string
                  - name: workingDir
                    value: string
                  - name: livenessProbe
                    value:
                      - name: initialDelaySeconds
                        value: integer
                      - name: timeoutSeconds
                        value: integer
                      - name: periodSeconds
                        value: integer
                      - name: failureThreshold
                        value: integer
                      - name: httpGet
                        value:
                          - name: path
                            value: string
                          - name: httpHeaders
                            value:
                              - - name: name
                                  value: string
                                - name: value
                                  value: string
                          - name: port
                            value: integer
                      - name: tcpSocket
                        value:
                          - name: port
                            value: integer
                      - name: grpc
                        value:
                          - name: port
                            value: integer
                          - name: service
                            value: string
                  - name: dependsOn
                    value:
                      - string
            - name: volumes
              value:
                - - name: name
                    value: string
                  - name: secret
                    value:
                      - name: secret
                        value: string
                      - name: items
                        value:
                          - - name: path
                              value: string
                            - name: version
                              value: string
                            - name: mode
                              value: integer
                      - name: defaultMode
                        value: integer
                  - name: cloudSqlInstance
                    value:
                      - name: instances
                        value:
                          - string
                  - name: emptyDir
                    value:
                      - name: medium
                        value: string
                      - name: sizeLimit
                        value: string
                  - name: nfs
                    value:
                      - name: server
                        value: string
                      - name: path
                        value: string
                      - name: readOnly
                        value: boolean
                  - name: gcs
                    value:
                      - name: bucket
                        value: string
                      - name: readOnly
                        value: boolean
            - name: maxRetries
              value: integer
            - name: timeout
              value: string
            - name: serviceAccount
              value: string
            - name: executionEnvironment
              value: string
            - name: encryptionKey
              value: string
            - name: vpcAccess
              value:
                - name: connector
                  value: string
                - name: egress
                  value: string
                - name: networkInterfaces
                  value:
                    - - name: network
                        value: string
                      - name: subnetwork
                        value: string
                      - name: tags
                        value:
                          - string
    - name: observedGeneration
      value: string
    - name: terminalCondition
      value:
        - name: type
          value: string
        - name: state
          value: string
        - name: message
          value: string
        - name: lastTransitionTime
          value: string
        - name: severity
          value: string
        - name: reason
          value: string
        - name: revisionReason
          value: string
        - name: executionReason
          value: string
    - name: conditions
      value:
        - - name: type
            value: string
          - name: state
            value: string
          - name: message
            value: string
          - name: lastTransitionTime
            value: string
          - name: severity
            value: string
          - name: reason
            value: string
          - name: revisionReason
            value: string
          - name: executionReason
            value: string
    - name: executionCount
      value: integer
    - name: latestCreatedExecution
      value:
        - name: name
          value: string
        - name: createTime
          value: string
        - name: completionTime
          value: string
        - name: deleteTime
          value: string
        - name: completionStatus
          value: string
    - name: reconciling
      value: boolean
    - name: satisfiesPzs
      value: boolean
    - name: startExecutionToken
      value: string
    - name: runExecutionToken
      value: string
    - name: etag
      value: string

UPDATE example

Updates a jobs resource.

/*+ update */
UPDATE google.run.jobs
SET 
name = '{{ name }}',
labels = '{{ labels }}',
annotations = '{{ annotations }}',
client = '{{ client }}',
clientVersion = '{{ clientVersion }}',
launchStage = '{{ launchStage }}',
binaryAuthorization = '{{ binaryAuthorization }}',
template = '{{ template }}',
startExecutionToken = '{{ startExecutionToken }}',
runExecutionToken = '{{ runExecutionToken }}'
WHERE 
jobsId = '{{ jobsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified jobs resource.

/*+ delete */
DELETE FROM google.run.jobs
WHERE jobsId = '{{ jobsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';