executions

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

Overview

Name	executions
Type	Resource
Id	google.aiplatform.executions

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the Execution.
createTime	string (google-datetime)	Output only. Timestamp when this Execution was created.
description	string	Description of the Execution
displayName	string	User provided display name of the Execution. May be up to 128 Unicode characters.
etag	string	An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	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).
metadata	object	Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
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 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.
state	string	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 AI Pipelines) and the system does not prescribe or check the validity of state transitions.
updateTime	string (google-datetime)	Output only. Timestamp when this Execution was last updated.

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the Execution.
createTime	string (google-datetime)	Output only. Timestamp when this Execution was created.
description	string	Description of the Execution
displayName	string	User provided display name of the Execution. May be up to 128 Unicode characters.
etag	string	An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	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).
metadata	object	Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
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 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.
state	string	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 AI Pipelines) and the system does not prescribe or check the validity of state transitions.
updateTime	string (google-datetime)	Output only. Timestamp when this Execution was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, metadataStoresId, executionsId		Retrieves a specific Execution.
list	select	projectsId, locationsId, metadataStoresId	pageSize, pageToken, filter, orderBy	Lists Executions in the MetadataStore.
create	insert	projectsId, locationsId, metadataStoresId	executionId	Creates an Execution associated with a MetadataStore.
patch	update	projectsId, locationsId, metadataStoresId, executionsId	updateMask, allowMissing	Updates a stored Execution.
delete	delete	projectsId, locationsId, metadataStoresId, executionsId	etag	Deletes an Execution.
purge	exec	projectsId, locationsId, metadataStoresId		Purges Executions.
add_execution_events	exec	projectsId, locationsId, metadataStoresId, executionsId		Adds 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.

Name	Datatype	Description
executionsId	string
locationsId	string
metadataStoresId	string
projectsId	string
allowMissing	boolean
etag	string
executionId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

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;

list

Lists Executions in the MetadataStore.

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 pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates an Execution associated with a MetadataStore.

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

Manifest

# Description fields are for documentation purposes
- name: executions
  props:
    - name: projectsId
      value: string
      description: Required parameter for the executions resource.
    - name: locationsId
      value: string
      description: Required parameter for the executions resource.
    - name: metadataStoresId
      value: string
      description: Required parameter for the executions resource.
    - name: displayName
      value: string
      description: >
        User provided display name of the Execution. May be up to 128 Unicode characters.
        
    - name: state
      value: string
      description: >
        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 AI Pipelines) and the system does not prescribe or check the validity of state transitions.
        
      valid_values: ['STATE_UNSPECIFIED', 'NEW', 'RUNNING', 'COMPLETE', 'FAILED', 'CACHED', 'CANCELLED']
    - name: etag
      value: string
      description: >
        An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
        
    - name: labels
      value: object
      description: >
        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).
        
    - name: schemaTitle
      value: string
      description: >
        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.
        
    - name: schemaVersion
      value: string
      description: >
        The 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.
        
    - name: metadata
      value: object
      description: >
        Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
        
    - name: description
      value: string
      description: >
        Description of the Execution
        
    - name: executionId
      value: string

UPDATE examples

patch

Updates a stored Execution.

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

DELETE examples

delete

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

purge

Purges Executions.

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

add_execution_events

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

EXEC google.aiplatform.executions.add_execution_events 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@metadataStoresId='{{ metadataStoresId }}' --required, 
@executionsId='{{ executionsId }}' --required 
@@json=
'{
"events": "{{ events }}"
}';