REST Resource: projects.locations.metadataStores.executions

Resource: Execution

Instance of a general execution.

JSON representation
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "etag": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "schemaTitle": string,
  "schemaVersion": string,
  "metadata": {
    object
  },
  "description": string
}
Fields
name

string

Output only. The resource name of the Execution.

displayName

string

User provided display name of the Execution. May be up to 128 Unicode characters.

state

enum (State)

The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex Pipelines) and the system does not prescribe or check the validity of state transitions.

etag

string

An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

labels

map (key: string, value: string)

The labels with user-defined metadata to organize your Executions.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).

createTime

string (Timestamp format)

Output only. Timestamp when this Execution was created.

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

updateTime

string (Timestamp format)

Output only. Timestamp when this Execution was last updated.

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

schemaTitle

string

The title of the schema describing the metadata.

Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.

schemaVersion

string

The version of the schema in schemaTitle to use.

Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.

metadata

object (Struct format)

Properties of the Execution. The size of this field should not exceed 200KB.

description

string

Description of the Execution

State

Describes the state of the Execution.

Enums
STATE_UNSPECIFIED Unspecified Execution state
NEW The Execution is new
RUNNING The Execution is running
COMPLETE The Execution has finished running
FAILED The Execution has failed
CACHED The Execution completed through Cache hit.
CANCELLED The Execution was cancelled.

Methods

addExecutionEvents

Adds Events to the specified Execution.

create

Creates an Execution associated with a MetadataStore.

delete

Deletes an Execution.

get

Retrieves a specific Execution.

list

Lists Executions in the MetadataStore.

patch

Updates a stored Execution.

purge

Purges Executions.

queryExecutionInputsAndOutputs

Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.