Skip to main content

artifacts

Overview

Nameartifacts
TypeResource
Idgoogle.aiplatform.artifacts

Fields

NameDatatypeDescription
namestringOutput only. The resource name of the Artifact.
descriptionstringDescription of the Artifact
createTimestringOutput only. Timestamp when this Artifact was created.
displayNamestringUser provided display name of the Artifact. 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 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).
metadataobjectProperties of the Artifact. 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_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.
statestringThe 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.
updateTimestringOutput only. Timestamp when this Artifact was last updated.
uristringThe uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.

Methods

NameAccessible byRequired ParamsDescription
getSELECTartifactsId, locationsId, metadataStoresId, projectsIdRetrieves a specific Artifact.
listSELECTlocationsId, metadataStoresId, projectsIdLists Artifacts in the MetadataStore.
createINSERTlocationsId, metadataStoresId, projectsIdCreates an Artifact associated with a MetadataStore.
deleteDELETEartifactsId, locationsId, metadataStoresId, projectsIdDeletes an Artifact.
_listEXEClocationsId, metadataStoresId, projectsIdLists Artifacts in the MetadataStore.
patchEXECartifactsId, locationsId, metadataStoresId, projectsIdUpdates a stored Artifact.
purgeEXEClocationsId, metadataStoresId, projectsIdPurges Artifacts.
query_artifact_lineage_subgraphEXECartifactsId, locationsId, metadataStoresId, projectsIdRetrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.