Skip to main content

executions

Overview

Nameexecutions
TypeResource
Idgoogle.aiplatform.executions

Fields

NameDatatypeDescription
namestringOutput only. The resource name of the Execution.
descriptionstringDescription of the Execution
createTimestringOutput only. Timestamp when this Execution was created.
displayNamestringUser provided display name of the Execution. May be up to 128 Unicode characters.
etagstringAn eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labelsobjectThe 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).
metadataobjectProperties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
schemaTitlestringThe 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.
schemaVersionstringThe version of the schema in schema_title 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.
statestringThe 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 AI Pipelines) and the system does not prescribe or check the validity of state transitions.
updateTimestringOutput only. Timestamp when this Execution was last updated.

Methods

NameAccessible byRequired ParamsDescription
getSELECTexecutionsId, locationsId, metadataStoresId, projectsIdRetrieves a specific Execution.
listSELECTlocationsId, metadataStoresId, projectsIdLists Executions in the MetadataStore.
createINSERTlocationsId, metadataStoresId, projectsIdCreates an Execution associated with a MetadataStore.
deleteDELETEexecutionsId, locationsId, metadataStoresId, projectsIdDeletes an Execution.
_listEXEClocationsId, metadataStoresId, projectsIdLists Executions in the MetadataStore.
patchEXECexecutionsId, locationsId, metadataStoresId, projectsIdUpdates a stored Execution.
purgeEXEClocationsId, metadataStoresId, projectsIdPurges Executions.
query_execution_inputs_and_outputsEXECexecutionsId, locationsId, metadataStoresId, projectsIdObtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.