Class Artifact (1.18.2)

Artifact(
    artifact_name: str,
    *,
    metadata_store_id: str = "default",
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

Metadata Artifact resource for Vertex AI

Inheritance

builtins.object > google.cloud.aiplatform.base.VertexAiResourceNoun > builtins.object > google.cloud.aiplatform.base.FutureManager > google.cloud.aiplatform.base.VertexAiResourceNounWithFutureManager > builtins.object > abc.ABC > google.cloud.aiplatform.metadata.resource._Resource > Artifact

Properties

create_time

Time this resource was created.

display_name

Display name of this resource.

encryption_spec

Customer-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_resource

The underlying resource proto representation.

labels

User-defined labels containing metadata about this resource.

Read more about labels at https://goo.gl/xmQnxf

lineage_console_uri

Cloud console uri to view this Artifact Lineage.

name

Name of this resource.

resource_name

Full qualified resource name.

state

The State for this Artifact.

update_time

Time this resource was last updated.

uri

Uri for this Artifact.

Methods

Artifact

Artifact(
    artifact_name: str,
    *,
    metadata_store_id: str = "default",
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

Retrieves an existing Metadata Artifact given a resource name or ID.

Parameters
NameDescription
artifact_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.

create

create(schema_title: str, *, resource_id: Optional[str] = None, uri: Optional[str] = None, display_name: Optional[str] = None, schema_version: Optional[str] = None, description: Optional[str] = None, metadata: Optional[Dict] = None, state: google.cloud.aiplatform_v1.types.artifact.Artifact.State = <State.LIVE: 2>, metadata_store_id: Optional[str] = 'default', project: Optional[str] = None, location: Optional[str] = None, credentials: Optional[google.auth.credentials.Credentials] = None)

Creates a new Metadata Artifact.

Parameters
NameDescription
schema_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
TypeDescription
ArtifactInstantiated representation of the managed Metadata Artifact.

delete

delete(sync: bool = True)

Deletes this Vertex AI resource. WARNING: This deletion is permanent.

Parameter
NameDescription
sync bool

Whether to execute this deletion synchronously. If False, this method will be executed in concurrent Future and any downstream object will be immediately returned and synced when the Future has completed.

get

get(
    resource_id: str,
    metadata_store_id: str = "default",
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None,
)

Retrieves a Metadata resource.

Parameters
NameDescription
resource_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
TypeDescription
resource (_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: Optional[str] = None,
    schema_version: Optional[str] = None,
    description: Optional[str] = None,
    metadata: Optional[Dict] = None,
    metadata_store_id: str = "default",
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None,
)

Retrieves or Creates (if it does not exist) a Metadata resource.

Parameters
NameDescription
resource_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
TypeDescription
resource (_Resource)Instantiated representation of the managed Metadata resource.

get_with_uri

get_with_uri(
    uri: str,
    *,
    metadata_store_id: Optional[str] = "default",
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

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
NameDescription
uri 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
TypeDescription
ValueErrorIf no Artifact exists with the provided uri.
Returns
TypeDescription
ArtifactArtifact with given uri.

list

list(
    filter: Optional[str] = None,
    metadata_store_id: str = "default",
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None,
)

List Metadata resources that match the list filter in target metadataStore.

Parameters
NameDescription
filter 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.

Returns
TypeDescription
resources (sequence[_Resource])a list of managed Metadata resource.

sync_resource

sync_resource()

Syncs local resource with the resource in metadata store.

to_dict

to_dict()

Returns the resource proto as a dictionary.

update

update(
    metadata: Optional[Dict] = None,
    description: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None,
)

Updates an existing Metadata resource with new metadata.

Parameters
NameDescription
metadata 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.

wait

wait()

Helper method that blocks until all futures are complete.