Method: projects.locations.lakes.tasks.run

Run an on demand execution of a Task.

HTTP request

POST https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/lakes/*/tasks/*}:run

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the task: projects/{project_number}/locations/{locationId}/lakes/{lakeId}/tasks/{taskId}.

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

  • dataplex.tasks.run

Request body

The request body contains data with the following structure:

JSON representation 
{
  "labels": {
    string: string,
    ...
  },
  "args": {
    string: string,
    ...
  }
}
Fields
labels

map (key: string, value: string)

Optional. User-defined labels for the task. If the map is left empty, the task will run with existing labels from task definition. If the map contains an entry with a new key, the same will be added to existing set of labels. If the map contains an entry with an existing label key in task definition, the task will run with new label value for that entry. Clearing an existing label will require label value to be explicitly set to a hyphen "-". The label value cannot be empty.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
args

map (key: string, value: string)

Optional. Execution spec arguments. If the map is left empty, the task will run with existing execution spec args from task definition. If the map contains an entry with a new key, the same will be added to existing set of args. If the map contains an entry with an existing arg key in task definition, the task will run with new arg value for that entry. Clearing an existing arg will require arg value to be explicitly set to a hyphen "-". The arg value cannot be empty.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "job": {
    object (Job)
  }
}
Fields
job

object (Job)

Jobs created by tasks.run API.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • dataplex.tasks.run

For more information, see the IAM documentation.