artifacts

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

Overview

Name	artifacts
Type	Resource
Id	google.aiplatform.artifacts

Fields

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

Name	Accessible by	Required Params	Description
get	SELECT	artifactsId, locationsId, metadataStoresId, projectsId	Retrieves a specific Artifact.
list	SELECT	locationsId, metadataStoresId, projectsId	Lists Artifacts in the MetadataStore.
query_artifact_lineage_subgraph	SELECT	artifactsId, locationsId, metadataStoresId, projectsId	Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
create	INSERT	locationsId, metadataStoresId, projectsId	Creates an Artifact associated with a MetadataStore.
delete	DELETE	artifactsId, locationsId, metadataStoresId, projectsId	Deletes an Artifact.
patch	UPDATE	artifactsId, locationsId, metadataStoresId, projectsId	Updates a stored Artifact.
purge	EXEC	locationsId, metadataStoresId, projectsId	Purges Artifacts.

SELECT examples

Lists Artifacts in the MetadataStore.

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

INSERT example

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

All Properties

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

Manifest

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

UPDATE example

Updates a artifacts resource.

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

DELETE example

Deletes the specified artifacts resource.

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