Method: projects.locations.jobs.run

Triggers creation of a new Execution of this Job.

HTTP request

POST https://{endpoint}/v2/{name}:run

Where {endpoint} is one of the supported service endpoints.

Path parameters

Parameters
name

string

Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number. It takes the form projects/{project}/locations/{location}/jobs/{job}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "validateOnly": boolean,
  "etag": string,
  "overrides": {
    object (Overrides)
  }
}
Fields
validateOnly

boolean

Indicates that the request should be validated without actually deleting any resources.
etag

string

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

object (Overrides)

Overrides specification for a given execution of a job. If provided, overrides will be applied to update the execution or task spec.

Authorization requires the following IAM permission on the specified resource overrides:

  • run.jobs.runWithOverrides

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Overrides

jobs.run Overrides that contains Execution fields to be overridden.

JSON representation 
{
  "containerOverrides": [
    {
      object (ContainerOverride)
    }
  ],
  "taskCount": integer,
  "timeout": string
}
Fields
containerOverrides[]

object (ContainerOverride)

Per container override specification.
taskCount

integer

Optional. The desired number of tasks the execution should run. Will replace existing taskCount value.
timeout

string (Duration format)

Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. Will replace existing timeoutSeconds value.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

ContainerOverride

Per-container override specification.

JSON representation 
{
  "name": string,
  "args": [
    string
  ],
  "env": [
    {
      object (EnvVar)
    }
  ],
  "clearArgs": boolean
}
Fields
name

string

The name of the container specified as a DNS_LABEL.
args[]

string

Optional. Arguments to the entrypoint. Will replace existing args for override.
env[]

object (EnvVar)

List of environment variables to set in the container. Will be merged with existing env for override.
clearArgs

boolean

Optional. True if the intention is to clear out existing args list.