Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates an Artifact associated with a MetadataStore.

post/v1/{+parent}/artifacts

Path parameters

parentstring required

Required. The resource name of the MetadataStore where the Artifact should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Query parameters

artifactIdstring

The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)

Request body

namestring

Output only. The resource name of the Artifact.

descriptionstring

Description of the Artifact

displayNamestring

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

createTimestring google-datetime

Output only. Timestamp when this Artifact was created.

state'STATE_UNSPECIFIED' | 'PENDING' | 'LIVE'

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.

metadataobject

Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.

schemaTitlestring

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.

schemaVersionstring

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.

etagstring

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

labelsobject

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

updateTimestring google-datetime

Output only. Timestamp when this Artifact was last updated.

uristring

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

Response

Successful response