Class MigrationServiceAsyncClient (1.3.0) 

MigrationServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.aiplatform_v1.services.migration_service.transports.base.MigrationServiceTransport] = '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>)

A service that migrates resources from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.

Inheritance

builtins.object > MigrationServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
Type Description
MigrationServiceTransport The transport used by the client instance.

Methods

MigrationServiceAsyncClient

MigrationServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.aiplatform_v1.services.migration_service.transports.base.MigrationServiceTransport] = '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 migration service client.

Parameters
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, `.MigrationServiceTransport`]

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 transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
Exceptions
Type Description
google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason.

annotated_dataset_path

annotated_dataset_path(project: str, dataset: str, annotated_dataset: str)

Returns a fully-qualified annotated_dataset string.

batch_migrate_resources

batch_migrate_resources(request: Optional[google.cloud.aiplatform_v1.types.migration_service.BatchMigrateResourcesRequest] = None, *, parent: Optional[str] = None, migrate_resource_requests: Optional[Sequence[google.cloud.aiplatform_v1.types.migration_service.MigrateResourceRequest]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

Parameters
Name Description
request BatchMigrateResourcesRequest

The request object. Request message for MigrationService.BatchMigrateResources.
parent `str`

Required. The location of the migrated resource will live in. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
migrate_resource_requests :class:`Sequence[google.cloud.aiplatform_v1.types.MigrateResourceRequest]`

Required. The request messages specifying the resources to migrate. They must be in the same location as the destination. Up to 50 resources can be migrated in one batch. This corresponds to the migrate_resource_requests field on the request instance; if request is provided, this should not be set.
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.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be BatchMigrateResourcesResponse Response message for MigrationService.BatchMigrateResources.

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.

dataset_path

dataset_path(project: str, dataset: str)

Returns a fully-qualified dataset string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
MigrationServiceAsyncClient 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.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
MigrationServiceAsyncClient 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.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
MigrationServiceAsyncClient The constructed client.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

model_path

model_path(project: str, location: str, model: str)

Returns a fully-qualified model string.

parse_annotated_dataset_path

parse_annotated_dataset_path(path: str)

Parses a annotated_dataset 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_dataset_path

parse_dataset_path(path: str)

Parses a dataset path into its component segments.

parse_model_path

parse_model_path(path: str)

Parses a model path into its component segments.

parse_version_path

parse_version_path(path: str)

Parses a version path into its component segments.

search_migratable_resources

search_migratable_resources(request: Optional[google.cloud.aiplatform_v1.types.migration_service.SearchMigratableResourcesRequest] = 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]] = ())

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

Parameters
Name Description
request SearchMigratableResourcesRequest

The request object. Request message for MigrationService.SearchMigratableResources.
parent `str`

Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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.
Returns
Type Description
google.cloud.aiplatform_v1.services.migration_service.pagers.SearchMigratableResourcesAsyncPager Response message for MigrationService.SearchMigratableResources. Iterating over this object will yield results and resolve additional pages automatically.

version_path

version_path(project: str, model: str, version: str)

Returns a fully-qualified version string.