Class MigrationServiceClient (0.11.6)

MigrationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigquery_migration_v2.services.migration_service.transports.base.MigrationServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service to handle EDW migrations.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
`str`	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

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

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
`str`	The universe domain used by the client instance.

Methods

MigrationServiceClient

MigrationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigquery_migration_v2.services.migration_service.transports.base.MigrationServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS 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. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that the `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_migration_workflow

create_migration_workflow(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_migration_v2.types.migration_service.CreateMigrationWorkflowRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    migration_workflow: typing.Optional[
        google.cloud.bigquery_migration_v2.types.migration_entities.MigrationWorkflow
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_migration_v2.types.migration_entities.MigrationWorkflow

Creates a migration workflow.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_migration_v2

def sample_create_migration_workflow():
    # Create a client
    client = bigquery_migration_v2.MigrationServiceClient()

    # Initialize request argument(s)
    request = bigquery_migration_v2.CreateMigrationWorkflowRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_migration_workflow(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_migration_v2.types.CreateMigrationWorkflowRequest, dict]` The request object. Request to create a migration workflow resource.
`parent`	`str` Required. The name of the project to which this migration workflow belongs. Example: `projects/foo/locations/bar` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`migration_workflow`	`google.cloud.bigquery_migration_v2.types.MigrationWorkflow` Required. The migration workflow to create. This corresponds to the `migration_workflow` 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.bigquery_migration_v2.types.MigrationWorkflow`	A migration workflow which specifies what needs to be done for an EDW migration.

delete_migration_workflow

delete_migration_workflow(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_migration_v2.types.migration_service.DeleteMigrationWorkflowRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a migration workflow by name.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_migration_v2

def sample_delete_migration_workflow():
    # Create a client
    client = bigquery_migration_v2.MigrationServiceClient()

    # Initialize request argument(s)
    request = bigquery_migration_v2.DeleteMigrationWorkflowRequest(
        name="name_value",
    )

    # Make the request
    client.delete_migration_workflow(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_migration_v2.types.DeleteMigrationWorkflowRequest, dict]` The request object. A request to delete a previously created migration workflow.
`name`	`str` Required. The unique identifier for the migration workflow. Example: `projects/123/locations/us/workflows/1234` This corresponds to the `name` 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.

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
`MigrationServiceClient`	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
`MigrationServiceClient`	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
`MigrationServiceClient`	The constructed client.

get_migration_subtask

get_migration_subtask(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_migration_v2.types.migration_service.GetMigrationSubtaskRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_migration_v2.types.migration_entities.MigrationSubtask

Gets a previously created migration subtask.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_migration_v2

def sample_get_migration_subtask():
    # Create a client
    client = bigquery_migration_v2.MigrationServiceClient()

    # Initialize request argument(s)
    request = bigquery_migration_v2.GetMigrationSubtaskRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_migration_subtask(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_migration_v2.types.GetMigrationSubtaskRequest, dict]` The request object. A request to get a previously created migration subtasks.
`name`	`str` Required. The unique identifier for the migration subtask. Example: `projects/123/locations/us/workflows/1234/subtasks/543` This corresponds to the `name` 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.bigquery_migration_v2.types.MigrationSubtask`	A subtask for a migration which carries details about the configuration of the subtask. The content of the details should not matter to the end user, but is a contract between the subtask creator and subtask worker.

get_migration_workflow

get_migration_workflow(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_migration_v2.types.migration_service.GetMigrationWorkflowRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_migration_v2.types.migration_entities.MigrationWorkflow

Gets a previously created migration workflow.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_migration_v2

def sample_get_migration_workflow():
    # Create a client
    client = bigquery_migration_v2.MigrationServiceClient()

    # Initialize request argument(s)
    request = bigquery_migration_v2.GetMigrationWorkflowRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_migration_workflow(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_migration_v2.types.GetMigrationWorkflowRequest, dict]` The request object. A request to get a previously created migration workflow.
`name`	`str` Required. The unique identifier for the migration workflow. Example: `projects/123/locations/us/workflows/1234` This corresponds to the `name` 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.bigquery_migration_v2.types.MigrationWorkflow`	A migration workflow which specifies what needs to be done for an EDW migration.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

list_migration_subtasks

list_migration_subtasks(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_migration_v2.types.migration_service.ListMigrationSubtasksRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.bigquery_migration_v2.services.migration_service.pagers.ListMigrationSubtasksPager
)

Lists previously created migration subtasks.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_migration_v2

def sample_list_migration_subtasks():
    # Create a client
    client = bigquery_migration_v2.MigrationServiceClient()

    # Initialize request argument(s)
    request = bigquery_migration_v2.ListMigrationSubtasksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_migration_subtasks(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksRequest, dict]` The request object. A request to list previously created migration subtasks.
`parent`	`str` Required. The migration task of the subtasks to list. Example: `projects/123/locations/us/workflows/1234` 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.bigquery_migration_v2.services.migration_service.pagers.ListMigrationSubtasksPager`	Response object for a ListMigrationSubtasks call. Iterating over this object will yield results and resolve additional pages automatically.

list_migration_workflows

list_migration_workflows(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_migration_v2.types.migration_service.ListMigrationWorkflowsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.bigquery_migration_v2.services.migration_service.pagers.ListMigrationWorkflowsPager
)

Lists previously created migration workflow.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_migration_v2

def sample_list_migration_workflows():
    # Create a client
    client = bigquery_migration_v2.MigrationServiceClient()

    # Initialize request argument(s)
    request = bigquery_migration_v2.ListMigrationWorkflowsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_migration_workflows(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsRequest, dict]` The request object. A request to list previously created migration workflows.
`parent`	`str` Required. The project and location of the migration workflows to list. Example: `projects/123/locations/us` 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.bigquery_migration_v2.services.migration_service.pagers.ListMigrationWorkflowsPager`	Response object for a ListMigrationWorkflows call. Iterating over this object will yield results and resolve additional pages automatically.

migration_subtask_path

migration_subtask_path(
    project: str, location: str, workflow: str, subtask: str
) -> str

Returns a fully-qualified migration_subtask string.

migration_workflow_path

migration_workflow_path(project: str, location: str, workflow: str) -> str

Returns a fully-qualified migration_workflow string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_migration_subtask_path

parse_migration_subtask_path(path: str) -> typing.Dict[str, str]

Parses a migration_subtask path into its component segments.

parse_migration_workflow_path

parse_migration_workflow_path(path: str) -> typing.Dict[str, str]

Parses a migration_workflow path into its component segments.

start_migration_workflow

start_migration_workflow(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_migration_v2.types.migration_service.StartMigrationWorkflowRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_migration_v2

def sample_start_migration_workflow():
    # Create a client
    client = bigquery_migration_v2.MigrationServiceClient()

    # Initialize request argument(s)
    request = bigquery_migration_v2.StartMigrationWorkflowRequest(
        name="name_value",
    )

    # Make the request
    client.start_migration_workflow(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_migration_v2.types.StartMigrationWorkflowRequest, dict]` The request object. A request to start a previously created migration workflow.
`name`	`str` Required. The unique identifier for the migration workflow. Example: `projects/123/locations/us/workflows/1234` This corresponds to the `name` 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.