executions

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

Overview

Name	executions
Type	Resource
Id	google.aiplatform.executions

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the Execution.
description	string	Description of the Execution
createTime	string	Output only. Timestamp when this Execution was created.
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	Output only. Timestamp when this Execution was last updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	executionsId, locationsId, metadataStoresId, projectsId	Retrieves a specific Execution.
list	SELECT	locationsId, metadataStoresId, projectsId	Lists Executions in the MetadataStore.
query_execution_inputs_and_outputs	SELECT	executionsId, locationsId, metadataStoresId, projectsId	Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
create	INSERT	locationsId, metadataStoresId, projectsId	Creates an Execution associated with a MetadataStore.
delete	DELETE	executionsId, locationsId, metadataStoresId, projectsId	Deletes an Execution.
patch	UPDATE	executionsId, locationsId, metadataStoresId, projectsId	Updates a stored Execution.
purge	EXEC	locationsId, metadataStoresId, projectsId	Purges Executions.

SELECT examples

Lists Executions in the MetadataStore.

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

INSERT example

Use the following StackQL query and manifest file to create a new executions resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.executions (
locationsId,
metadataStoresId,
projectsId,
schemaVersion,
metadata,
labels,
displayName,
description,
state,
schemaTitle,
etag
)
SELECT 
'{{ locationsId }}',
'{{ metadataStoresId }}',
'{{ projectsId }}',
'{{ schemaVersion }}',
'{{ metadata }}',
'{{ labels }}',
'{{ displayName }}',
'{{ description }}',
'{{ state }}',
'{{ schemaTitle }}',
'{{ etag }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: schemaVersion
      value: string
    - name: metadata
      value: object
    - name: createTime
      value: string
    - name: labels
      value: object
    - name: name
      value: string
    - name: updateTime
      value: string
    - name: displayName
      value: string
    - name: description
      value: string
    - name: state
      value: string
    - name: schemaTitle
      value: string
    - name: etag
      value: string

UPDATE example

Updates a executions resource.

/*+ update */
UPDATE google.aiplatform.executions
SET 
schemaVersion = '{{ schemaVersion }}',
metadata = '{{ metadata }}',
labels = '{{ labels }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
state = '{{ state }}',
schemaTitle = '{{ schemaTitle }}',
etag = '{{ etag }}'
WHERE 
executionsId = '{{ executionsId }}'
AND locationsId = '{{ locationsId }}'
AND metadataStoresId = '{{ metadataStoresId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified executions resource.

/*+ delete */
DELETE FROM google.aiplatform.executions
WHERE executionsId = '{{ executionsId }}'
AND locationsId = '{{ locationsId }}'
AND metadataStoresId = '{{ metadataStoresId }}'
AND projectsId = '{{ projectsId }}';