REST Resource: projects.locations.metadataStores.artifacts

Resource: Artifact

Instance of a general artifact.

JSON representation
{
  "name": string,
  "displayName": string,
  "uri": string,
  "etag": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "schemaTitle": string,
  "schemaVersion": string,
  "metadata": {
    object
  },
  "description": string
}
Fields
name

string

Output only. The resource name of the Artifact.

displayName

string

User provided display name of the Artifact. May be up to 128 Unicode characters.

uri

string

The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.

etag

string

An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

labels

map (key: string, value: string)

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

createTime

string (Timestamp format)

Output only. Timestamp when this Artifact was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Timestamp when this Artifact was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)

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 Pipelines), and the system does not prescribe or check the validity of state transitions.

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.

metadata

object (Struct format)

Properties of the Artifact. The size of this field should not exceed 200KB.

description

string

Description of the Artifact

State

Describes the state of the Artifact.

Enums
STATE_UNSPECIFIED Unspecified state for the Artifact.
PENDING A state used by systems like Vertex Pipelines to indicate that the underlying data item represented by this Artifact is being created.
LIVE A state indicating that the Artifact should exist, unless something external to the system deletes it.

Methods

create

Creates an Artifact associated with a MetadataStore.

delete

Deletes an Artifact.

get

Retrieves a specific Artifact.

list

Lists Artifacts in the MetadataStore.

patch

Updates a stored Artifact.

purge

Purges Artifacts.

queryArtifactLineageSubgraph

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