Class Execution (1.44.0)

Version 1.44.0

• 1.75.0 (latest)
• 1.74.0
• 1.73.0
• 1.72.0
• 1.71.1
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.1
• 1.66.0
• 1.65.0
• 1.63.0
• 1.62.0
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.1
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

Execution(
    execution_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 Execution resource for Vertex AI

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

name

Name of this resource.

resource_name

Full qualified resource name.

state

State of this Execution.

update_time

Time this resource was last updated.

Methods

Execution

Execution(
    execution_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 Execution given a resource name or ID.

Parameters
Name	Description
execution_name	str Required. A fully-qualified resource name or resource ID of the Execution. Example: "projects/123/locations/us-central1/metadataStores/default/executions/my-resource". or "my-resource" when project and location are initialized or passed.
metadata_store_id	str Optional. MetadataStore to retrieve Execution from. If not set, metadata_store_id is set to "default". If execution_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 Execution from. If not set, location set in aiplatform.init will be used.
credentials	auth_credentials.Credentials Optional. Custom credentials to use to retrieve this Execution. Overrides credentials set in aiplatform.init.

assign_input_artifacts

assign_input_artifacts(
    artifacts: typing.List[
        typing.Union[
            google.cloud.aiplatform.metadata.artifact.Artifact,
            google.cloud.aiplatform.models.Model,
        ]
    ]
)

Assigns Artifacts as inputs to this Executions.

Parameter
Name	Description
artifacts	List[Union[artifact.Artifact, models.Model]] Required. Artifacts to assign as input.

assign_output_artifacts

assign_output_artifacts(
    artifacts: typing.List[
        typing.Union[
            google.cloud.aiplatform.metadata.artifact.Artifact,
            google.cloud.aiplatform.models.Model,
        ]
    ]
)

Assigns Artifacts as outputs to this Executions.

Parameter
Name	Description
artifacts	List[Union[artifact.Artifact, models.Model]] Required. Artifacts to assign as input.

create

create(
    schema_title: str,
    *,
    state: google.cloud.aiplatform_v1.types.execution.Execution.State = State.RUNNING,
    resource_id: typing.Optional[str] = None,
    display_name: typing.Optional[str] = None,
    schema_version: typing.Optional[str] = None,
    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None,
    description: 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]
) -> google.cloud.aiplatform.metadata.execution.Execution

Creates a new Metadata Execution.

Parameters
Name	Description
schema_title	str Required. schema_title identifies the schema title used by the Execution.
state	gca_execution.Execution.State.RUNNING Optional. State of this Execution. Defaults to RUNNING.
resource_id	str Optional. The <resource_id> portion of the Execution name with the format. This is globally unique in a metadataStore: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/executions/<resource_id>.
display_name	str Optional. The user-defined name of the Execution.
schema_version	str Optional. schema_version specifies the version used by the Execution. If not set, defaults to use the latest version.
metadata	Dict Optional. Contains the metadata information that will be stored in the Execution.
description	str Optional. Describes the purpose of the Execution to be created.
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 Execution. Overrides project set in aiplatform.init.
location	str Optional. Location used to create this Execution. Overrides location set in aiplatform.init.
credentials	auth_credentials.Credentials Optional. Custom credentials used to create this Execution. Overrides credentials set in aiplatform.init.

Returns
Type	Description
Execution	Instantiated representation of the managed Metadata Execution.

delete

delete(sync: bool = True) -> None

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

Parameter
Name	Description
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: 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	Description
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
Type	Description
resource (_Resource)	Instantiated representation of the managed Metadata resource or None if no resource was found.

get_input_artifacts

get_input_artifacts() -> (
    typing.List[google.cloud.aiplatform.metadata.artifact.Artifact]
)

Get the input Artifacts of this Execution.

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	Description
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
Type	Description
resource (_Resource)	Instantiated representation of the managed Metadata resource.

get_output_artifacts

get_output_artifacts() -> (
    typing.List[google.cloud.aiplatform.metadata.artifact.Artifact]
)

Get the output Artifacts of this Execution.

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

Returns
Type	Description
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() -> typing.Dict[str, typing.Any]

Returns the resource proto as a dictionary.

update

update(
    state: typing.Optional[
        google.cloud.aiplatform_v1.types.execution.Execution.State
    ] = None,
    description: typing.Optional[str] = None,
    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None,
)

Update this Execution.

Parameters
Name	Description
state	gca_execution.Execution.State Optional. State of this Execution.
description	str Optional. Describes the purpose of the Execution to be created.
metadata	Dict[str, Any Optional. Contains the metadata information that will be stored in the Execution.

wait

wait()

Helper method that blocks until all futures are complete.