REST Resource: projects.locations.processes.runs

Resource: Run

A lineage run represents an execution of a process that creates lineage events.

JSON representation
{
  "name": string,
  "displayName": string,
  "attributes": {
    string: value,
    ...
  },
  "startTime": string,
  "endTime": string,
  "state": enum (State)
}
Fields
name

string

Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.

displayName

string

Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.

attributes

map (key: string, value: value (Value format))

Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run).

Up to 100 attributes are allowed.

startTime

string (Timestamp format)

Required. The timestamp of the start of the run.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Optional. The timestamp of the end of the run.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Required. The state of the run.

State

The current state of the run.

Enums
UNKNOWN The state is unknown. The true state may be any of the below or a different state that is not supported here explicitly.
STARTED The run is still executing.
COMPLETED The run completed.
FAILED The run failed.
ABORTED The run aborted.

Methods

create

Creates a new run.

delete

Deletes the run with the specified name.

get

Gets the details of the specified run.

list

Lists runs in the given project and location.

patch

Updates a run.