- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- Overrides
- ContainerOverride
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 |
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 Authorization requires the following IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"overrides": {
object ( |
Fields | |
---|---|
overrides |
Optional. 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
|
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 ( |
Fields | |
---|---|
containerOverrides[] |
Per container override specification. |
taskCount |
The desired number of tasks the execution should run. Will replace existing taskCount value. |
timeoutSeconds |
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 ( |
Fields | |
---|---|
name |
The name of the container specified as a DNS_LABEL. |
args[] |
Arguments to the entrypoint. Will replace existing args for override. |
env[] |
List of environment variables to set in the container. Will be merged with existing env for override. |