- 1.63.0 (latest)
- 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
MetadataServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.aiplatform_v1beta1.services.metadata_service.transports.base.MetadataServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-aiplatform/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Service for reading and writing metadata entries.
Inheritance
builtins.object > MetadataServiceAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
MetadataServiceTransport | The transport used by the client instance. |
Methods
MetadataServiceAsyncClient
MetadataServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.aiplatform_v1beta1.services.metadata_service.transports.base.MetadataServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-aiplatform/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the metadata service client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, `.MetadataServiceTransport`]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
add_context_artifacts_and_executions
add_context_artifacts_and_executions(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.AddContextArtifactsAndExecutionsRequest] = None, *, context: Optional[str] = None, artifacts: Optional[Sequence[str]] = None, executions: Optional[Sequence[str]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.
Name | Description |
request |
AddContextArtifactsAndExecutionsRequest
The request object. Request message for MetadataService.AddContextArtifactsAndExecutions. |
context |
`str`
Required. The resource name of the Context that the Artifacts and Executions belong to. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context} This corresponds to the |
artifacts |
:class:`Sequence[str]`
The resource names of the Artifacts to attribute to the Context. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} This corresponds to the |
executions |
:class:`Sequence[str]`
The resource names of the Executions to associate with the Context. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.AddContextArtifactsAndExecutionsResponse | Response message for MetadataService.AddContextArtifactsAndExecutions. |
add_context_children
add_context_children(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.AddContextChildrenRequest] = None, *, context: Optional[str] = None, child_contexts: Optional[Sequence[str]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.
Name | Description |
request |
AddContextChildrenRequest
The request object. Request message for MetadataService.AddContextChildren. |
context |
`str`
Required. The resource name of the parent Context. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context} This corresponds to the |
child_contexts |
:class:`Sequence[str]`
The resource names of the child Contexts. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.AddContextChildrenResponse | Response message for MetadataService.AddContextChildren. |
add_execution_events
add_execution_events(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.AddExecutionEventsRequest] = None, *, execution: Optional[str] = None, events: Optional[Sequence[google.cloud.aiplatform_v1beta1.types.event.Event]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.
Name | Description |
request |
AddExecutionEventsRequest
The request object. Request message for MetadataService.AddExecutionEvents. |
execution |
`str`
Required. The resource name of the Execution that the Events connect Artifacts with. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} This corresponds to the |
events |
:class:`Sequence[google.cloud.aiplatform_v1beta1.types.Event]`
The Events to create and add. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.AddExecutionEventsResponse | Response message for MetadataService.AddExecutionEvents. |
artifact_path
artifact_path(project: str, location: str, metadata_store: str, artifact: str)
Returns a fully-qualified artifact string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
context_path
context_path(project: str, location: str, metadata_store: str, context: str)
Returns a fully-qualified context string.
create_artifact
create_artifact(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.CreateArtifactRequest] = None, *, parent: Optional[str] = None, artifact: Optional[google.cloud.aiplatform_v1beta1.types.artifact.Artifact] = None, artifact_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates an Artifact associated with a MetadataStore.
Name | Description |
request |
CreateArtifactRequest
The request object. Request message for MetadataService.CreateArtifact. |
parent |
`str`
Required. The resource name of the MetadataStore where the Artifact should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
artifact |
Artifact
Required. The Artifact to create. This corresponds to the |
artifact_id |
`str`
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 / |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.Artifact | Instance of a general artifact. |
create_context
create_context(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.CreateContextRequest] = None, *, parent: Optional[str] = None, context: Optional[google.cloud.aiplatform_v1beta1.types.context.Context] = None, context_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a Context associated with a MetadataStore.
Name | Description |
request |
CreateContextRequest
The request object. Request message for MetadataService.CreateContext. |
parent |
`str`
Required. The resource name of the MetadataStore where the Context should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
context |
Context
Required. The Context to create. This corresponds to the |
context_id |
`str`
The {context} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are / |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.Context | Instance of a general context. |
create_execution
create_execution(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.CreateExecutionRequest] = None, *, parent: Optional[str] = None, execution: Optional[google.cloud.aiplatform_v1beta1.types.execution.Execution] = None, execution_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates an Execution associated with a MetadataStore.
Name | Description |
request |
CreateExecutionRequest
The request object. Request message for MetadataService.CreateExecution. |
parent |
`str`
Required. The resource name of the MetadataStore where the Execution should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
execution |
Execution
Required. The Execution to create. This corresponds to the |
execution_id |
`str`
The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are / |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.Execution | Instance of a general execution. |
create_metadata_schema
create_metadata_schema(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.CreateMetadataSchemaRequest] = None, *, parent: Optional[str] = None, metadata_schema: Optional[google.cloud.aiplatform_v1beta1.types.metadata_schema.MetadataSchema] = None, metadata_schema_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a MetadataSchema.
Name | Description |
request |
CreateMetadataSchemaRequest
The request object. Request message for MetadataService.CreateMetadataSchema. |
parent |
`str`
Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
metadata_schema |
MetadataSchema
Required. The MetadataSchema to create. This corresponds to the |
metadata_schema_id |
`str`
The {metadata_schema} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema} If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are / |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.MetadataSchema | Instance of a general MetadataSchema. |
create_metadata_store
create_metadata_store(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.CreateMetadataStoreRequest] = None, *, parent: Optional[str] = None, metadata_store: Optional[google.cloud.aiplatform_v1beta1.types.metadata_store.MetadataStore] = None, metadata_store_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Initializes a MetadataStore, including allocation of resources.
Name | Description |
request |
CreateMetadataStoreRequest
The request object. Request message for MetadataService.CreateMetadataStore. |
parent |
`str`
Required. The resource name of the Location where the MetadataStore should be created. Format: projects/{project}/locations/{location}/ This corresponds to the |
metadata_store |
MetadataStore
Required. The MetadataStore to create. This corresponds to the |
metadata_store_id |
`str`
The {metadatastore} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore} If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are / |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be MetadataStore Instance of a metadata store. Contains a set of metadata that can be queried. |
delete_artifact
delete_artifact(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteArtifactRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes an Artifact.
Name | Description |
request |
DeleteArtifactRequest
The request object. Request message for MetadataService.DeleteArtifact. |
name |
`str`
Required. The resource name of the Artifact to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
delete_context
delete_context(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteContextRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a stored Context.
Name | Description |
request |
DeleteContextRequest
The request object. Request message for MetadataService.DeleteContext. |
name |
`str`
Required. The resource name of the Context to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
delete_execution
delete_execution(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteExecutionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes an Execution.
Name | Description |
request |
DeleteExecutionRequest
The request object. Request message for MetadataService.DeleteExecution. |
name |
`str`
Required. The resource name of the Execution to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
delete_metadata_store
delete_metadata_store(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.DeleteMetadataStoreRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
Name | Description |
request |
DeleteMetadataStoreRequest
The request object. Request message for MetadataService.DeleteMetadataStore. |
name |
`str`
Required. The resource name of the MetadataStore to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
execution_path
execution_path(project: str, location: str, metadata_store: str, execution: str)
Returns a fully-qualified execution string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
MetadataServiceAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
MetadataServiceAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
MetadataServiceAsyncClient | The constructed client. |
get_artifact
get_artifact(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.GetArtifactRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves a specific Artifact.
Name | Description |
request |
GetArtifactRequest
The request object. Request message for MetadataService.GetArtifact. |
name |
`str`
Required. The resource name of the Artifact to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.Artifact | Instance of a general artifact. |
get_context
get_context(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.GetContextRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves a specific Context.
Name | Description |
request |
GetContextRequest
The request object. Request message for MetadataService.GetContext. |
name |
`str`
Required. The resource name of the Context to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.Context | Instance of a general context. |
get_execution
get_execution(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.GetExecutionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves a specific Execution.
Name | Description |
request |
GetExecutionRequest
The request object. Request message for MetadataService.GetExecution. |
name |
`str`
Required. The resource name of the Execution to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.Execution | Instance of a general execution. |
get_metadata_schema
get_metadata_schema(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.GetMetadataSchemaRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves a specific MetadataSchema.
Name | Description |
request |
GetMetadataSchemaRequest
The request object. Request message for MetadataService.GetMetadataSchema. |
name |
`str`
Required. The resource name of the MetadataSchema to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.MetadataSchema | Instance of a general MetadataSchema. |
get_metadata_store
get_metadata_store(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.GetMetadataStoreRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves a specific MetadataStore.
Name | Description |
request |
GetMetadataStoreRequest
The request object. Request message for MetadataService.GetMetadataStore. |
name |
`str`
Required. The resource name of the MetadataStore to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.MetadataStore | Instance of a metadata store. Contains a set of metadata that can be queried. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
list_artifacts
list_artifacts(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.ListArtifactsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists Artifacts in the MetadataStore.
Name | Description |
request |
ListArtifactsRequest
The request object. Request message for MetadataService.ListArtifacts. |
parent |
`str`
Required. The MetadataStore whose Artifacts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListArtifactsAsyncPager | Response message for MetadataService.ListArtifacts. Iterating over this object will yield results and resolve additional pages automatically. |
list_contexts
list_contexts(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.ListContextsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists Contexts on the MetadataStore.
Name | Description |
request |
ListContextsRequest
The request object. Request message for MetadataService.ListContexts |
parent |
`str`
Required. The MetadataStore whose Contexts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListContextsAsyncPager | Response message for MetadataService.ListContexts. Iterating over this object will yield results and resolve additional pages automatically. |
list_executions
list_executions(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.ListExecutionsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists Executions in the MetadataStore.
Name | Description |
request |
ListExecutionsRequest
The request object. Request message for MetadataService.ListExecutions. |
parent |
`str`
Required. The MetadataStore whose Executions should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListExecutionsAsyncPager | Response message for MetadataService.ListExecutions. Iterating over this object will yield results and resolve additional pages automatically. |
list_metadata_schemas
list_metadata_schemas(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataSchemasRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists MetadataSchemas.
Name | Description |
request |
ListMetadataSchemasRequest
The request object. Request message for MetadataService.ListMetadataSchemas. |
parent |
`str`
Required. The MetadataStore whose MetadataSchemas should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataSchemasAsyncPager | Response message for MetadataService.ListMetadataSchemas. Iterating over this object will yield results and resolve additional pages automatically. |
list_metadata_stores
list_metadata_stores(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.ListMetadataStoresRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists MetadataStores for a Location.
Name | Description |
request |
ListMetadataStoresRequest
The request object. Request message for MetadataService.ListMetadataStores. |
parent |
`str`
Required. The Location whose MetadataStores should be listed. Format: projects/{project}/locations/{location} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.services.metadata_service.pagers.ListMetadataStoresAsyncPager | Response message for MetadataService.ListMetadataStores. Iterating over this object will yield results and resolve additional pages automatically. |
metadata_schema_path
metadata_schema_path(
project: str, location: str, metadata_store: str, metadata_schema: str
)
Returns a fully-qualified metadata_schema string.
metadata_store_path
metadata_store_path(project: str, location: str, metadata_store: str)
Returns a fully-qualified metadata_store string.
parse_artifact_path
parse_artifact_path(path: str)
Parses a artifact path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_context_path
parse_context_path(path: str)
Parses a context path into its component segments.
parse_execution_path
parse_execution_path(path: str)
Parses a execution path into its component segments.
parse_metadata_schema_path
parse_metadata_schema_path(path: str)
Parses a metadata_schema path into its component segments.
parse_metadata_store_path
parse_metadata_store_path(path: str)
Parses a metadata_store path into its component segments.
purge_artifacts
purge_artifacts(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.PurgeArtifactsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Purges Artifacts.
Name | Description |
request |
PurgeArtifactsRequest
The request object. Request message for MetadataService.PurgeArtifacts. |
parent |
`str`
Required. The metadata store to purge Artifacts from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be PurgeArtifactsResponse Response message for MetadataService.PurgeArtifacts. |
purge_contexts
purge_contexts(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.PurgeContextsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Purges Contexts.
Name | Description |
request |
PurgeContextsRequest
The request object. Request message for MetadataService.PurgeContexts. |
parent |
`str`
Required. The metadata store to purge Contexts from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be PurgeContextsResponse Response message for MetadataService.PurgeContexts. |
purge_executions
purge_executions(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.PurgeExecutionsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Purges Executions.
Name | Description |
request |
PurgeExecutionsRequest
The request object. Request message for MetadataService.PurgeExecutions. |
parent |
`str`
Required. The metadata store to purge Executions from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be PurgeExecutionsResponse Response message for MetadataService.PurgeExecutions. |
query_artifact_lineage_subgraph
query_artifact_lineage_subgraph(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.QueryArtifactLineageSubgraphRequest] = None, *, artifact: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
Name | Description |
request |
QueryArtifactLineageSubgraphRequest
The request object. Request message for MetadataService.QueryArtifactLineageSubgraph. |
artifact |
`str`
Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.LineageSubgraph | A subgraph of the overall lineage graph. Event edges connect Artifact and Execution nodes. |
query_context_lineage_subgraph
query_context_lineage_subgraph(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.QueryContextLineageSubgraphRequest] = None, *, context: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
Name | Description |
request |
QueryContextLineageSubgraphRequest
The request object. Request message for MetadataService.QueryContextLineageSubgraph. |
context |
`str`
Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context} The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.LineageSubgraph | A subgraph of the overall lineage graph. Event edges connect Artifact and Execution nodes. |
query_execution_inputs_and_outputs
query_execution_inputs_and_outputs(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.QueryExecutionInputsAndOutputsRequest] = None, *, execution: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
Name | Description |
request |
QueryExecutionInputsAndOutputsRequest
The request object. Request message for MetadataService.QueryExecutionInputsAndOutputs. |
execution |
`str`
Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.LineageSubgraph | A subgraph of the overall lineage graph. Event edges connect Artifact and Execution nodes. |
update_artifact
update_artifact(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.UpdateArtifactRequest] = None, *, artifact: Optional[google.cloud.aiplatform_v1beta1.types.artifact.Artifact] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a stored Artifact.
Name | Description |
request |
UpdateArtifactRequest
The request object. Request message for MetadataService.UpdateArtifact. |
artifact |
Artifact
Required. The Artifact containing updates. The Artifact's Artifact.name field is used to identify the Artifact to be updated. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} This corresponds to the |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
Required. A FieldMask indicating which fields should be updated. Functionality of this field is not yet supported. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.Artifact | Instance of a general artifact. |
update_context
update_context(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.UpdateContextRequest] = None, *, context: Optional[google.cloud.aiplatform_v1beta1.types.context.Context] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a stored Context.
Name | Description |
request |
UpdateContextRequest
The request object. Request message for MetadataService.UpdateContext. |
context |
Context
Required. The Context containing updates. The Context's Context.name field is used to identify the Context to be updated. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context} This corresponds to the |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
Required. A FieldMask indicating which fields should be updated. Functionality of this field is not yet supported. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.Context | Instance of a general context. |
update_execution
update_execution(request: Optional[google.cloud.aiplatform_v1beta1.types.metadata_service.UpdateExecutionRequest] = None, *, execution: Optional[google.cloud.aiplatform_v1beta1.types.execution.Execution] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a stored Execution.
Name | Description |
request |
UpdateExecutionRequest
The request object. Request message for MetadataService.UpdateExecution. |
execution |
Execution
Required. The Execution containing updates. The Execution's Execution.name field is used to identify the Execution to be updated. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} This corresponds to the |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
Required. A FieldMask indicating which fields should be updated. Functionality of this field is not yet supported. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.aiplatform_v1beta1.types.Execution | Instance of a general execution. |