Method: namespaces.jobs.run

Trigger creation of a new execution of this job.

HTTP request

POST https://{endpoint}/apis/run.googleapis.com/v1/{name}:run

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

Path parameters

Parameters
name

string

Required. The name of the job to run. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID It takes the form namespaces/{namespace}/jobs/{job}.

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

  • run.jobs.run

Request body

The request body contains data with the following structure:

JSON representation 
{
  "overrides": {
    object (Overrides)
  }
}
Fields
overrides

object (Overrides)

Optional. Overrides existing job configuration for one specific new job execution only, using the specified values to update the job configuration for the new execution.

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 Execution.

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 on the go.

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

object (ContainerOverride)

Per container override specification.
taskCount

integer

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

integer

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.

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

Arguments to the entrypoint. The specified arguments replace and override any existing entrypoint arguments. Must be empty if clearArgs is set to true.
env[]

object (EnvVar)

List of environment variables to set in the container. All specified environment variables are merged with existing environment variables. When the specified environment variables exist, these values override any existing values.
clearArgs

boolean

Optional. Set to True to clear all existing arguments.