artifacts

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

Overview

Name	artifacts
Type	Resource
Id	google.aiplatform.artifacts

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the Artifact.
createTime	string (google-datetime)	Output only. Timestamp when this Artifact was created.
description	string	Description of the Artifact
displayName	string	User provided display name of the Artifact. 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 Artifacts. 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 Artifact (System labels are excluded).
metadata	object	Properties of the Artifact. 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_name 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 Artifact. This is a property of the Artifact, 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 Artifact was last updated.
uri	string	The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.

query_artifact_lineage_subgraph

Successful response

Name	Datatype	Description
artifacts	array	The Artifact nodes in the subgraph.
events	array	The Event edges between Artifacts and Executions in the subgraph.
executions	array	The Execution nodes in the subgraph.

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the Artifact.
createTime	string (google-datetime)	Output only. Timestamp when this Artifact was created.
description	string	Description of the Artifact
displayName	string	User provided display name of the Artifact. 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 Artifacts. 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 Artifact (System labels are excluded).
metadata	object	Properties of the Artifact. 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_name 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 Artifact. This is a property of the Artifact, 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 Artifact was last updated.
uri	string	The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, metadataStoresId, artifactsId		Retrieves a specific Artifact.
query_artifact_lineage_subgraph	select	projectsId, locationsId, metadataStoresId, artifactsId	maxHops, filter	Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
list	select	projectsId, locationsId, metadataStoresId	pageSize, pageToken, filter, orderBy	Lists Artifacts in the MetadataStore.
create	insert	projectsId, locationsId, metadataStoresId	artifactId	Creates an Artifact associated with a MetadataStore.
patch	update	projectsId, locationsId, metadataStoresId, artifactsId	updateMask, allowMissing	Updates a stored Artifact.
delete	delete	projectsId, locationsId, metadataStoresId, artifactsId	etag	Deletes an Artifact.
purge	exec	projectsId, locationsId, metadataStoresId		Purges Artifacts.

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
artifactsId	string
locationsId	string
metadataStoresId	string
projectsId	string
allowMissing	boolean
artifactId	string
etag	string
filter	string
maxHops	integer (int32)
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Retrieves a specific Artifact.

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

query_artifact_lineage_subgraph

Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.

SELECT
artifacts,
events,
executions
FROM google.aiplatform.artifacts
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND metadataStoresId = '{{ metadataStoresId }}' -- required
AND artifactsId = '{{ artifactsId }}' -- required
AND maxHops = '{{ maxHops }}'
AND filter = '{{ filter }}';

list

Lists Artifacts in the MetadataStore.

SELECT
name,
createTime,
description,
displayName,
etag,
labels,
metadata,
schemaTitle,
schemaVersion,
state,
updateTime,
uri
FROM google.aiplatform.artifacts
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 Artifact associated with a MetadataStore.

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

Manifest

# Description fields are for documentation purposes
- name: artifacts
  props:
    - name: projectsId
      value: string
      description: Required parameter for the artifacts resource.
    - name: locationsId
      value: string
      description: Required parameter for the artifacts resource.
    - name: metadataStoresId
      value: string
      description: Required parameter for the artifacts resource.
    - name: displayName
      value: string
      description: >
        User provided display name of the Artifact. May be up to 128 Unicode characters.
        
    - name: uri
      value: string
      description: >
        The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
        
    - 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 Artifacts. 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 Artifact (System labels are excluded).
        
    - name: state
      value: string
      description: >
        The state of this Artifact. This is a property of the Artifact, 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', 'PENDING', 'LIVE']
    - 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_name 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 Artifact. 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 Artifact
        
    - name: artifactId
      value: string

UPDATE examples

patch

Updates a stored Artifact.

UPDATE google.aiplatform.artifacts
SET 
data__displayName = '{{ displayName }}',
data__uri = '{{ uri }}',
data__etag = '{{ etag }}',
data__labels = '{{ labels }}',
data__state = '{{ state }}',
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 artifactsId = '{{ artifactsId }}' --required
AND updateMask = '{{ updateMask}}'
AND allowMissing = {{ allowMissing}}
RETURNING
name,
createTime,
description,
displayName,
etag,
labels,
metadata,
schemaTitle,
schemaVersion,
state,
updateTime,
uri;

DELETE examples

delete

Deletes an Artifact.

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

Lifecycle Methods

purge

Purges Artifacts.

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