younifyd
Menu

Run.projects.locations.jobs.run

Triggers creation of a new Execution of this Job.

POST/v2/{name}:run

Use it in a workflow

  1. Add a step and choose the Google Cloud Run Jobs connector.
  2. Pick the Run.projects.locations.jobs.run action (under projects).
  3. Fill in the fields below, then reference the result from later steps as {{runProjectsLocationsJobsRun.response.data}}.

Request

Path parameters

namestringrequired

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

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart").

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart").

Request body

Enter the body as JSON in the step's Body field.

etagstring

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

validateOnlyboolean

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

json
{
  "etag": "string",
  "validateOnly": false
}

Response

Returns 200 with an object. Read it in later steps with {{runProjectsLocationsJobsRun.response.data.<field>}}.

doneboolean

If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

errorobject

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

codeinteger (int32)

The status code, which should be an enum value of google.rpc.Code.

detailsarray<object>

A list of messages that carry the error details. There is a common set of message types for APIs to use.

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

responseobject

The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

json
{
  "done": false,
  "error": {
    "code": 0,
    "details": [
      {}
    ],
    "message": "string"
  },
  "metadata": {},
  "name": "string",
  "response": {}
}

Need more? See the Google Cloud Run Jobs guide for connection setup and behaviour shared by every action.

Was this page helpful?