Stay organized with collections Save and categorize content based on your preferences.
Artifact(
artifact_name: str,
*,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
)
Metadata Artifact resource for Vertex AI
Properties create_timeTime this resource was created.
display_nameDisplay name of this resource.
encryption_specCustomer-managed encryption key options for this Vertex AI resource.
If this is set, then all resources created by this Vertex AI resource will be encrypted with the provided encryption key.
gca_resourceThe underlying resource proto representation.
labelsUser-defined labels containing metadata about this resource.
Read more about labels at https://goo.gl/xmQnxf
lineage_console_uriCloud console uri to view this Artifact Lineage.
nameName of this resource.
resource_nameFull qualified resource name.
stateThe State for this Artifact.
update_timeTime this resource was last updated.
uriUri for this Artifact.
Methods ArtifactArtifact(
artifact_name: str,
*,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
)
Retrieves an existing Metadata Artifact given a resource name or ID.
Parameters Name Descriptionartifact_name
str
Required. A fully-qualified resource name or resource ID of the Artifact. Example: "projects/123/locations/us-central1/metadataStores/default/artifacts/my-resource". or "my-resource" when project and location are initialized or passed.
metadata_store_id
str
Optional. MetadataStore to retrieve Artifact from. If not set, metadata_store_id is set to "default". If artifact_name is a fully-qualified resource, its metadata_store_id overrides this one.
project
str
Optional. Project to retrieve the artifact from. If not set, project set in aiplatform.init will be used.
location
str
Optional. Location to retrieve the Artifact from. If not set, location set in aiplatform.init will be used.
credentials
auth_credentials.Credentials
Optional. Custom credentials to use to retrieve this Artifact. Overrides credentials set in aiplatform.init.
createcreate(
schema_title: str,
*,
resource_id: typing.Optional[str] = None,
uri: typing.Optional[str] = None,
display_name: typing.Optional[str] = None,
schema_version: typing.Optional[str] = None,
description: typing.Optional[str] = None,
metadata: typing.Optional[typing.Dict] = None,
state: google.cloud.aiplatform_v1.types.artifact.Artifact.State = State.LIVE,
metadata_store_id: typing.Optional[str] = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.artifact.Artifact
Creates a new Metadata Artifact.
Parameters Name Descriptionschema_title
str
Required. schema_title identifies the schema title used by the Artifact. Please reference https://cloud.google.com/vertex-ai/docs/ml-metadata/system-schemas.
resource_id
str
Optional. The <resource_id> portion of the Artifact name with the format. This is globally unique in a metadataStore: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/artifacts/<resource_id>.
uri
str
Optional. The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
display_name
str
Optional. The user-defined name of the Artifact.
schema_version
str
Optional. schema_version specifies the version used by the Artifact. If not set, defaults to use the latest version.
description
str
Optional. Describes the purpose of the Artifact to be created.
metadata
Dict
Optional. Contains the metadata information that will be stored in the Artifact.
state
google.cloud.gapic.types.Artifact.State
Optional. 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.
metadata_store_id
str
Optional. The <metadata_store_id> portion of the resource name with the format: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/artifacts/<resource_id> If not provided, the MetadataStore's ID will be set to "default".
project
str
Optional. Project used to create this Artifact. Overrides project set in aiplatform.init.
location
str
Optional. Location used to create this Artifact. Overrides location set in aiplatform.init.
credentials
auth_credentials.Credentials
Optional. Custom credentials used to create this Artifact. Overrides credentials set in aiplatform.init.
Returns Type DescriptionArtifact
Instantiated representation of the managed Metadata Artifact. delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource. WARNING: This deletion is permanent.
getget(
resource_id: str,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.metadata.resource._Resource
Retrieves a Metadata resource.
Parameters Name Descriptionresource_id
str
Required. The <resource_id> portion of the resource name with the format: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/<resource_noun>/<resource_id>.
metadata_store_id
str
The <metadata_store_id> portion of the resource name with the format: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/<resource_noun>/<resource_id> If not provided, the MetadataStore's ID will be set to "default".
project
str
Project used to retrieve or create this resource. Overrides project set in aiplatform.init.
location
str
Location used to retrieve or create this resource. Overrides location set in aiplatform.init.
credentials
auth_credentials.Credentials
Custom credentials used to retrieve or create this resource. Overrides credentials set in aiplatform.init.
Returns Type Descriptionresource (_Resource)
Instantiated representation of the managed Metadata resource or None if no resource was found. get_or_create
get_or_create(
resource_id: str,
schema_title: str,
display_name: typing.Optional[str] = None,
schema_version: typing.Optional[str] = None,
description: typing.Optional[str] = None,
metadata: typing.Optional[typing.Dict] = None,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> google.cloud.aiplatform.metadata.resource._Resource
Retrieves or Creates (if it does not exist) a Metadata resource.
Parameters Name Descriptionresource_id
str
Required. The <resource_id> portion of the resource name with the format: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/<resource_noun>/<resource_id>.
schema_title
str
Required. schema_title identifies the schema title used by the resource.
display_name
str
Optional. The user-defined name of the resource.
schema_version
str
Optional. schema_version specifies the version used by the resource. If not set, defaults to use the latest version.
description
str
Optional. Describes the purpose of the resource to be created.
metadata
Dict
Optional. Contains the metadata information that will be stored in the resource.
metadata_store_id
str
The <metadata_store_id> portion of the resource name with the format: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/<resource_noun>/<resource_id> If not provided, the MetadataStore's ID will be set to "default".
project
str
Project used to retrieve or create this resource. Overrides project set in aiplatform.init.
location
str
Location used to retrieve or create this resource. Overrides location set in aiplatform.init.
credentials
auth_credentials.Credentials
Custom credentials used to retrieve or create this resource. Overrides credentials set in aiplatform.init.
Returns Type Descriptionresource (_Resource)
Instantiated representation of the managed Metadata resource. get_with_uri
get_with_uri(
uri: str,
*,
metadata_store_id: typing.Optional[str] = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None
) -> google.cloud.aiplatform.metadata.artifact.Artifact
Get an Artifact by it's uri.
If more than one Artifact with this uri is in the metadata store then the Artifact with the latest create_time is returned.
Parameters Name Descriptionuri
str
Required. Uri of the Artifact to retrieve.
metadata_store_id
str
Optional. MetadataStore to retrieve Artifact from. If not set, metadata_store_id is set to "default". If artifact_name is a fully-qualified resource, its metadata_store_id overrides this one.
project
str
Optional. Project to retrieve the artifact from. If not set, project set in aiplatform.init will be used.
location
str
Optional. Location to retrieve the Artifact from. If not set, location set in aiplatform.init will be used.
credentials
auth_credentials.Credentials
Optional. Custom credentials to use to retrieve this Artifact. Overrides credentials set in aiplatform.init.
Exceptions Type DescriptionValueError
If no Artifact exists with the provided uri. Returns Type Description Artifact
Artifact with given uri. list
list(
filter: typing.Optional[str] = None,
metadata_store_id: str = "default",
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
order_by: typing.Optional[str] = None,
) -> typing.List[google.cloud.aiplatform.metadata.resource._Resource]
List resources that match the list filter in target metadataStore.
Parameters Name Descriptionfilter
str
Optional. A query to filter available resources for matching results.
metadata_store_id
str
The <metadata_store_id> portion of the resource name with the format: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/<resource_noun>/<resource_id> If not provided, the MetadataStore's ID will be set to "default".
project
str
Project used to create this resource. Overrides project set in aiplatform.init.
location
str
Location used to create this resource. Overrides location set in aiplatform.init.
credentials
auth_credentials.Credentials
Custom credentials used to create this resource. Overrides credentials set in aiplatform.init.
order_by
str
Optional. How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a .
character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.
resources (sequence[_Resource])
a list of managed Metadata resource. sync_resource
Syncs local resource with the resource in metadata store.
to_dictto_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
updateupdate(
metadata: typing.Optional[typing.Dict] = None,
description: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
location: typing.Optional[str] = None,
)
Updates an existing Metadata resource with new metadata.
Parameters Name Descriptionmetadata
Dict
Optional. metadata contains the updated metadata information.
description
str
Optional. Description describes the resource to be updated.
credentials
auth_credentials.Credentials
Custom credentials to use to update this resource. Overrides credentials set in aiplatform.init.
waitHelper method that blocks until all futures are complete.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4