Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1329141233.4 KB
projects

Updates a Job.

patch/v2/{+name}

Path parameters

namestring required

The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}

Query parameters

allowMissingboolean

Optional. If set to true, and if the Job does not exist, it will create a new one. Caller must have both create and update permissions for this call if this is set to true.

validateOnlyboolean

Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.

validateOnlyboolean

Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.

validateOnlyboolean

Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.

Request body

startExecutionTokenstring

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.

annotationsobject

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.

clientVersionstring

Arbitrary version identifier for the API client.

lastModifierstring

Output only. Email address of the last authenticated modifier.

satisfiesPzsboolean

Output only. Reserved for future use.

namestring

The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}

etagstring

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

generationstring int64

Output only. A number that monotonically increases every time the user modifies the desired state.

observedGenerationstring int64

Output only. The generation of this Job. See comments in reconciling for additional information on reconciliation process in Cloud Run.

creatorstring

Output only. Email address of the authenticated creator.

launchStage'LAUNCH_STAGE_UNSPECIFIED' | 'UNIMPLEMENTED' | 'PRELAUNCH' | 'EARLY_ACCESS' | 'ALPHA' | 'BETA' | 'GA' | 'DEPRECATED'

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.

runExecutionTokenstring

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.

reconcilingboolean

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.

createTimestring google-datetime

Output only. The creation time.

deleteTimestring google-datetime

Output only. The deletion time. It is only populated as a response to a Delete request.

uidstring

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.

expireTimestring google-datetime

Output only. For a deleted resource, the time after which it will be permamently deleted.

clientstring

Arbitrary identifier for the API client.

labelsobject

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.

updateTimestring google-datetime

Output only. The last-modified time.

executionCountinteger

Output only. Number of executions created for this job.

Response

Successful response