Skip to main content

executions

Creates, updates, deletes, gets or lists an executions resource.

Overview​

Nameexecutions
TypeResource
Idgoogle.aiplatform.executions

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringOutput only. The resource name of the Execution.
createTimestring (google-datetime)Output only. Timestamp when this Execution was created.
descriptionstringDescription of the Execution
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. (STATE_UNSPECIFIED, NEW, RUNNING, COMPLETE, FAILED, CACHED, CANCELLED)
updateTimestring (google-datetime)Output only. Timestamp when this Execution was last updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, metadataStoresId, executionsIdRetrieves a specific Execution.
listselectprojectsId, locationsId, metadataStoresIdfilter, pageToken, orderBy, pageSizeLists Executions in the MetadataStore.
createinsertprojectsId, locationsId, metadataStoresIdexecutionIdCreates an Execution associated with a MetadataStore.
patchupdateprojectsId, locationsId, metadataStoresId, executionsIdallowMissing, updateMaskUpdates a stored Execution.
deletedeleteprojectsId, locationsId, metadataStoresId, executionsIdetagDeletes an Execution.
purgeexecprojectsId, locationsId, metadataStoresIdPurges Executions.
add_execution_eventsexecprojectsId, locationsId, metadataStoresId, executionsIdAdds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
executionsIdstring
locationsIdstring
metadataStoresIdstring
projectsIdstring
allowMissingboolean
etagstring
executionIdstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)

SELECT examples​

Retrieves a specific Execution.

SELECT
name,
createTime,
description,
displayName,
etag,
labels,
metadata,
schemaTitle,
schemaVersion,
state,
updateTime
FROM google.aiplatform.executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND metadataStoresId = '{{ metadataStoresId }}' -- required
AND executionsId = '{{ executionsId }}' -- required
;

INSERT examples​

Creates an Execution associated with a MetadataStore.

INSERT INTO google.aiplatform.executions (
data__description,
data__state,
data__metadata,
data__labels,
data__schemaVersion,
data__schemaTitle,
data__displayName,
data__etag,
projectsId,
locationsId,
metadataStoresId,
executionId
)
SELECT 
'{{ description }}',
'{{ state }}',
'{{ metadata }}',
'{{ labels }}',
'{{ schemaVersion }}',
'{{ schemaTitle }}',
'{{ displayName }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ metadataStoresId }}',
'{{ executionId }}'
RETURNING
name,
createTime,
description,
displayName,
etag,
labels,
metadata,
schemaTitle,
schemaVersion,
state,
updateTime
;

UPDATE examples​

Updates a stored Execution.

UPDATE google.aiplatform.executions
SET 
data__description = '{{ description }}',
data__state = '{{ state }}',
data__metadata = '{{ metadata }}',
data__labels = '{{ labels }}',
data__schemaVersion = '{{ schemaVersion }}',
data__schemaTitle = '{{ schemaTitle }}',
data__displayName = '{{ displayName }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND metadataStoresId = '{{ metadataStoresId }}' --required
AND executionsId = '{{ executionsId }}' --required
AND allowMissing = {{ allowMissing}}
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
etag,
labels,
metadata,
schemaTitle,
schemaVersion,
state,
updateTime;

DELETE examples​

Deletes an Execution.

DELETE FROM google.aiplatform.executions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND metadataStoresId = '{{ metadataStoresId }}' --required
AND executionsId = '{{ executionsId }}' --required
AND etag = '{{ etag }}'
;

Lifecycle Methods​

Purges Executions.

EXEC google.aiplatform.executions.purge 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@metadataStoresId='{{ metadataStoresId }}' --required 
@@json=
'{
"filter": "{{ filter }}", 
"force": {{ force }}
}'
;