As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

VmMigration¶

class google.cloud.vmmigration_v1.services.vm_migration.VmMigrationAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.vmmigration_v1.services.vm_migration.transports.base.VmMigrationTransport, typing.Callable[[...], google.cloud.vmmigration_v1.services.vm_migration.transports.base.VmMigrationTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

VM Migration Service

Instantiates the vm migration async client.

Parameters

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 (Optional[Union[str,VmMigrationTransport,Callable[..., VmMigrationTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the VmMigrationTransport constructor. 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 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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async add_group_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.AddGroupMigrationRequest, dict]] = None, *, group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Adds a MigratingVm to a Group.

# 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 vmmigration_v1

async def sample_add_group_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.AddGroupMigrationRequest(
        group="group_value",
    )

    # Make the request
    operation = client.add_group_migration(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.AddGroupMigrationRequest, dict]]) – The request object. Request message for ‘AddGroupMigration’ request.
group (str) –
Required. The full path name of the Group to add to.

This corresponds to the group field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.AddGroupMigrationResponse Response message for ‘AddGroupMigration’ request.

Return type

google.api_core.operation_async.AsyncOperation

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

async cancel_clone_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CancelCloneJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Initiates the cancellation of a running clone job.

# 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 vmmigration_v1

async def sample_cancel_clone_job():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CancelCloneJobRequest(
        name="name_value",
    )

    # Make the request
    operation = client.cancel_clone_job(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.CancelCloneJobRequest, dict]]) – The request object. Request message for ‘CancelCloneJob’ request.
name (str) – Required. The clone job id This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.CancelCloneJobResponse Response message for ‘CancelCloneJob’ request.

Return type

google.api_core.operation_async.AsyncOperation

async cancel_cutover_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CancelCutoverJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Initiates the cancellation of a running cutover job.

# 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 vmmigration_v1

async def sample_cancel_cutover_job():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CancelCutoverJobRequest(
        name="name_value",
    )

    # Make the request
    operation = client.cancel_cutover_job(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.CancelCutoverJobRequest, dict]]) – The request object. Request message for ‘CancelCutoverJob’ request.
name (str) – Required. The cutover job id This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.CancelCutoverJobResponse Response message for ‘CancelCutoverJob’ request.

Return type

google.api_core.operation_async.AsyncOperation

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (CancelOperationRequest) – The request object. Request message for CancelOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

None

static clone_job_path(project: str, location: str, source: str, migrating_vm: str, clone_job: str) → str¶: Returns a fully-qualified clone_job string.

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_clone_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateCloneJobRequest, dict]] = None, *, parent: Optional[str] = None, clone_job: Optional[google.cloud.vmmigration_v1.types.vmmigration.CloneJob] = None, clone_job_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Initiates a Clone of a specific migrating VM.

# 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 vmmigration_v1

async def sample_create_clone_job():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateCloneJobRequest(
        parent="parent_value",
        clone_job_id="clone_job_id_value",
    )

    # Make the request
    operation = client.create_clone_job(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.CreateCloneJobRequest, dict]]) – The request object. Request message for ‘CreateCloneJob’ request.
parent (str) – Required. The Clone’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
clone_job (google.cloud.vmmigration_v1.types.CloneJob) – Required. The clone request body. This corresponds to the clone_job field on the request instance; if request is provided, this should not be set.
clone_job_id (str) – Required. The clone job identifier. This corresponds to the clone_job_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.CloneJob CloneJob describes the process of creating a clone of a: [MigratingVM][google.cloud.vmmigration.v1.MigratingVm] to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone.

Return type

google.api_core.operation_async.AsyncOperation

async create_cutover_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateCutoverJobRequest, dict]] = None, *, parent: Optional[str] = None, cutover_job: Optional[google.cloud.vmmigration_v1.types.vmmigration.CutoverJob] = None, cutover_job_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Initiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.

# 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 vmmigration_v1

async def sample_create_cutover_job():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateCutoverJobRequest(
        parent="parent_value",
        cutover_job_id="cutover_job_id_value",
    )

    # Make the request
    operation = client.create_cutover_job(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.CreateCutoverJobRequest, dict]]) – The request object. Request message for ‘CreateCutoverJob’ request.
parent (str) – Required. The Cutover’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
cutover_job (google.cloud.vmmigration_v1.types.CutoverJob) – Required. The cutover request body. This corresponds to the cutover_job field on the request instance; if request is provided, this should not be set.
cutover_job_id (str) – Required. The cutover job identifier. This corresponds to the cutover_job_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.CutoverJob CutoverJob message describes a cutover of a migrating VM. The CutoverJob is: the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.

Return type

google.api_core.operation_async.AsyncOperation

async create_datacenter_connector(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateDatacenterConnectorRequest, dict]] = None, *, parent: Optional[str] = None, datacenter_connector: Optional[google.cloud.vmmigration_v1.types.vmmigration.DatacenterConnector] = None, datacenter_connector_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new DatacenterConnector in a given Source.

# 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 vmmigration_v1

async def sample_create_datacenter_connector():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateDatacenterConnectorRequest(
        parent="parent_value",
        datacenter_connector_id="datacenter_connector_id_value",
    )

    # Make the request
    operation = client.create_datacenter_connector(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.CreateDatacenterConnectorRequest, dict]]) – The request object. Request message for ‘CreateDatacenterConnector’ request.
parent (str) –
Required. The DatacenterConnector’s parent. Required. The Source in where the new DatacenterConnector will be created. For example: projects/my-project/locations/us-central1/sources/my-source

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
datacenter_connector (google.cloud.vmmigration_v1.types.DatacenterConnector) – Required. The create request body. This corresponds to the datacenter_connector field on the request instance; if request is provided, this should not be set.
datacenter_connector_id (str) –
Required. The datacenterConnector identifier.

This corresponds to the datacenter_connector_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.DatacenterConnector DatacenterConnector message describes a connector between the Source and: Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer.

Return type

google.api_core.operation_async.AsyncOperation

async create_group(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateGroupRequest, dict]] = None, *, parent: Optional[str] = None, group: Optional[google.cloud.vmmigration_v1.types.vmmigration.Group] = None, group_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new Group in a given project and location.

# 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 vmmigration_v1

async def sample_create_group():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateGroupRequest(
        parent="parent_value",
        group_id="group_id_value",
    )

    # Make the request
    operation = client.create_group(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.CreateGroupRequest, dict]]) – The request object. Request message for ‘CreateGroup’ request.
parent (str) – Required. The Group’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
group (google.cloud.vmmigration_v1.types.Group) – Required. The create request body. This corresponds to the group field on the request instance; if request is provided, this should not be set.
group_id (str) – Required. The group identifier. This corresponds to the group_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.Group Describes message for ‘Group’ resource. The Group is a collections of several: MigratingVms.

Return type

google.api_core.operation_async.AsyncOperation

async create_migrating_vm(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateMigratingVmRequest, dict]] = None, *, parent: Optional[str] = None, migrating_vm: Optional[google.cloud.vmmigration_v1.types.vmmigration.MigratingVm] = None, migrating_vm_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new MigratingVm in a given Source.

# 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 vmmigration_v1

async def sample_create_migrating_vm():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateMigratingVmRequest(
        parent="parent_value",
        migrating_vm_id="migrating_vm_id_value",
    )

    # Make the request
    operation = client.create_migrating_vm(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.CreateMigratingVmRequest, dict]]) – The request object. Request message for ‘CreateMigratingVm’ request.
parent (str) – Required. The MigratingVm’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
migrating_vm (google.cloud.vmmigration_v1.types.MigratingVm) – Required. The create request body. This corresponds to the migrating_vm field on the request instance; if request is provided, this should not be set.
migrating_vm_id (str) – Required. The migratingVm identifier. This corresponds to the migrating_vm_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.MigratingVm MigratingVm describes the VM that will be migrated from a Source environment: and its replication state.

Return type

google.api_core.operation_async.AsyncOperation

async create_source(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateSourceRequest, dict]] = None, *, parent: Optional[str] = None, source: Optional[google.cloud.vmmigration_v1.types.vmmigration.Source] = None, source_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new Source in a given project and location.

# 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 vmmigration_v1

async def sample_create_source():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateSourceRequest(
        parent="parent_value",
        source_id="source_id_value",
    )

    # Make the request
    operation = client.create_source(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.CreateSourceRequest, dict]]) – The request object. Request message for ‘CreateSource’ request.
parent (str) – Required. The Source’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
source (google.cloud.vmmigration_v1.types.Source) – Required. The create request body. This corresponds to the source field on the request instance; if request is provided, this should not be set.
source_id (str) – Required. The source identifier. This corresponds to the source_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.Source Source message describes a specific vm migration Source resource. It contains: the source environment information.

Return type

google.api_core.operation_async.AsyncOperation

async create_target_project(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateTargetProjectRequest, dict]] = None, *, parent: Optional[str] = None, target_project: Optional[google.cloud.vmmigration_v1.types.vmmigration.TargetProject] = None, target_project_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new TargetProject in a given project.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

# 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 vmmigration_v1

async def sample_create_target_project():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateTargetProjectRequest(
        parent="parent_value",
        target_project_id="target_project_id_value",
    )

    # Make the request
    operation = client.create_target_project(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.CreateTargetProjectRequest, dict]]) – The request object. Request message for ‘CreateTargetProject’ request.
parent (str) – Required. The TargetProject’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
target_project (google.cloud.vmmigration_v1.types.TargetProject) – Required. The create request body. This corresponds to the target_project field on the request instance; if request is provided, this should not be set.
target_project_id (str) – Required. The target_project identifier. This corresponds to the target_project_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.TargetProject TargetProject message represents a target Compute Engine project for a: migration or a clone.

Return type

google.api_core.operation_async.AsyncOperation

async create_utilization_report(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateUtilizationReportRequest, dict]] = None, *, parent: Optional[str] = None, utilization_report: Optional[google.cloud.vmmigration_v1.types.vmmigration.UtilizationReport] = None, utilization_report_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new UtilizationReport.

# 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 vmmigration_v1

async def sample_create_utilization_report():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateUtilizationReportRequest(
        parent="parent_value",
        utilization_report_id="utilization_report_id_value",
    )

    # Make the request
    operation = client.create_utilization_report(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.CreateUtilizationReportRequest, dict]]) – The request object. Request message for ‘CreateUtilizationReport’ request.
parent (str) –
Required. The Utilization Report’s parent.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
utilization_report (google.cloud.vmmigration_v1.types.UtilizationReport) – Required. The report to create. This corresponds to the utilization_report field on the request instance; if request is provided, this should not be set.
utilization_report_id (str) –
Required. The ID to use for the report, which will become the final component of the reports’s resource name.

This value maximum length is 63 characters, and valid characters are /[a-z][0-9]-/. It must start with an english letter and must not end with a hyphen.

This corresponds to the utilization_report_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.UtilizationReport Utilization report details the utilization (CPU, memory, etc.) of selected: source VMs.

Return type

google.api_core.operation_async.AsyncOperation

static cutover_job_path(project: str, location: str, source: str, migrating_vm: str, cutover_job: str) → str¶: Returns a fully-qualified cutover_job string.

static datacenter_connector_path(project: str, location: str, source: str, datacenter_connector: str) → str¶: Returns a fully-qualified datacenter_connector string.

async delete_datacenter_connector(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteDatacenterConnectorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single DatacenterConnector.

# 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 vmmigration_v1

async def sample_delete_datacenter_connector():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteDatacenterConnectorRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_datacenter_connector(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.DeleteDatacenterConnectorRequest, dict]]) – The request object. Request message for ‘DeleteDatacenterConnector’ request.
name (str) –
Required. The DatacenterConnector name.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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:

Return type

google.api_core.operation_async.AsyncOperation

async delete_group(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteGroupRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single Group.

# 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 vmmigration_v1

async def sample_delete_group():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteGroupRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_group(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.DeleteGroupRequest, dict]]) – The request object. Request message for ‘DeleteGroup’ request.
name (str) – Required. The Group name. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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:

Return type

google.api_core.operation_async.AsyncOperation

async delete_migrating_vm(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteMigratingVmRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single MigratingVm.

# 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 vmmigration_v1

async def sample_delete_migrating_vm():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteMigratingVmRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_migrating_vm(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.DeleteMigratingVmRequest, dict]]) – The request object. Request message for ‘DeleteMigratingVm’ request.
name (str) –
Required. The name of the MigratingVm.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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:

Return type

google.api_core.operation_async.AsyncOperation

async delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

None

async delete_source(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteSourceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single Source.

# 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 vmmigration_v1

async def sample_delete_source():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteSourceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_source(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.DeleteSourceRequest, dict]]) – The request object. Request message for ‘DeleteSource’ request.
name (str) – Required. The Source name. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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:

Return type

google.api_core.operation_async.AsyncOperation

async delete_target_project(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteTargetProjectRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

# 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 vmmigration_v1

async def sample_delete_target_project():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteTargetProjectRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_target_project(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.DeleteTargetProjectRequest, dict]]) – The request object. Request message for ‘DeleteTargetProject’ request.
name (str) – Required. The TargetProject name. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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:

Return type

google.api_core.operation_async.AsyncOperation

async delete_utilization_report(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteUtilizationReportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single Utilization Report.

# 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 vmmigration_v1

async def sample_delete_utilization_report():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteUtilizationReportRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_utilization_report(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.DeleteUtilizationReportRequest, dict]]) – The request object. Request message for ‘DeleteUtilizationReport’ request.
name (str) –
Required. The Utilization Report name.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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:

Return type

google.api_core.operation_async.AsyncOperation

async fetch_inventory(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.FetchInventoryRequest, dict]] = None, *, source: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.FetchInventoryResponse[source]¶

List remote source’s inventory of VMs. The remote source is the onprem vCenter (remote in the sense it’s not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.

# 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 vmmigration_v1

async def sample_fetch_inventory():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.FetchInventoryRequest(
        source="source_value",
    )

    # Make the request
    response = await client.fetch_inventory(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.FetchInventoryRequest, dict]]) – The request object. Request message for [fetchInventory][google.cloud.vmmigration.v1.VmMigration.FetchInventory].
source (str) – Required. The name of the Source. This corresponds to the source field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for: [fetchInventory][google.cloud.vmmigration.v1.VmMigration.FetchInventory].

Return type

google.cloud.vmmigration_v1.types.FetchInventoryResponse

async finalize_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.FinalizeMigrationRequest, dict]] = None, *, migrating_vm: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Marks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done.

# 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 vmmigration_v1

async def sample_finalize_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.FinalizeMigrationRequest(
        migrating_vm="migrating_vm_value",
    )

    # Make the request
    operation = client.finalize_migration(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.FinalizeMigrationRequest, dict]]) – The request object. Request message for ‘FinalizeMigration’ request.
migrating_vm (str) –
Required. The name of the MigratingVm.

This corresponds to the migrating_vm field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.FinalizeMigrationResponse Response message for ‘FinalizeMigration’ request.

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VmMigrationAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VmMigrationAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VmMigrationAsyncClient

async get_clone_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetCloneJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.CloneJob[source]¶

Gets details of a single CloneJob.

# 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 vmmigration_v1

async def sample_get_clone_job():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetCloneJobRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_clone_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.GetCloneJobRequest, dict]]) – The request object. Request message for ‘GetCloneJob’ request.
name (str) – Required. The name of the CloneJob. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

CloneJob describes the process of creating a clone of a: [MigratingVM][google.cloud.vmmigration.v1.MigratingVm] to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone.

Return type

google.cloud.vmmigration_v1.types.CloneJob

async get_cutover_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetCutoverJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.CutoverJob[source]¶

Gets details of a single CutoverJob.

# 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 vmmigration_v1

async def sample_get_cutover_job():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetCutoverJobRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_cutover_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.GetCutoverJobRequest, dict]]) – The request object. Request message for ‘GetCutoverJob’ request.
name (str) – Required. The name of the CutoverJob. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.

Return type

google.cloud.vmmigration_v1.types.CutoverJob

async get_datacenter_connector(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetDatacenterConnectorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.DatacenterConnector[source]¶

Gets details of a single DatacenterConnector.

# 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 vmmigration_v1

async def sample_get_datacenter_connector():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetDatacenterConnectorRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_datacenter_connector(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.GetDatacenterConnectorRequest, dict]]) – The request object. Request message for ‘GetDatacenterConnector’ request.
name (str) –
Required. The name of the DatacenterConnector.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

DatacenterConnector message describes a connector between the Source and Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer.

Return type

google.cloud.vmmigration_v1.types.DatacenterConnector

async get_group(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetGroupRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.Group[source]¶

Gets details of a single Group.

# 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 vmmigration_v1

async def sample_get_group():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetGroupRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_group(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.GetGroupRequest, dict]]) – The request object. Request message for ‘GetGroup’ request.
name (str) – Required. The group name. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Describes message for ‘Group’ resource. The Group is a collections of several MigratingVms.

Return type

google.cloud.vmmigration_v1.types.Group

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Location object.

Return type

Location

async get_migrating_vm(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetMigratingVmRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.MigratingVm[source]¶

Gets details of a single MigratingVm.

# 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 vmmigration_v1

async def sample_get_migrating_vm():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetMigratingVmRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_migrating_vm(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.GetMigratingVmRequest, dict]]) – The request object. Request message for ‘GetMigratingVm’ request.
name (str) –
Required. The name of the MigratingVm.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

MigratingVm describes the VM that will be migrated from a Source environment and its replication state.

Return type

google.cloud.vmmigration_v1.types.MigratingVm

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

An Operation object.

Return type

Operation

async get_replication_cycle(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetReplicationCycleRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.ReplicationCycle[source]¶

Gets details of a single ReplicationCycle.

# 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 vmmigration_v1

async def sample_get_replication_cycle():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetReplicationCycleRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_replication_cycle(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.GetReplicationCycleRequest, dict]]) – The request object. Request message for ‘GetReplicationCycle’ request.
name (str) –
Required. The name of the ReplicationCycle.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

ReplicationCycle contains information about the current replication cycle status.

Return type

google.cloud.vmmigration_v1.types.ReplicationCycle

async get_source(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetSourceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.Source[source]¶

Gets details of a single Source.

# 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 vmmigration_v1

async def sample_get_source():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetSourceRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_source(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.GetSourceRequest, dict]]) – The request object. Request message for ‘GetSource’ request.
name (str) – Required. The Source name. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Source message describes a specific vm migration Source resource. It contains the source environment information.

Return type

google.cloud.vmmigration_v1.types.Source

async get_target_project(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetTargetProjectRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.TargetProject[source]¶

Gets details of a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

# 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 vmmigration_v1

async def sample_get_target_project():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetTargetProjectRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_target_project(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.GetTargetProjectRequest, dict]]) – The request object. Request message for ‘GetTargetProject’ call.
name (str) – Required. The TargetProject name. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

TargetProject message represents a target Compute Engine project for a migration or a clone.

Return type

google.cloud.vmmigration_v1.types.TargetProject

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.vmmigration_v1.services.vm_migration.transports.base.VmMigrationTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async get_utilization_report(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetUtilizationReportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.UtilizationReport[source]¶

Gets a single Utilization Report.

# 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 vmmigration_v1

async def sample_get_utilization_report():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetUtilizationReportRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_utilization_report(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.GetUtilizationReportRequest, dict]]) – The request object. Request message for ‘GetUtilizationReport’ request.
name (str) –
Required. The Utilization Report name.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.

Return type

google.cloud.vmmigration_v1.types.UtilizationReport

static group_path(project: str, location: str, group: str) → str¶: Returns a fully-qualified group string.

async list_clone_jobs(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListCloneJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCloneJobsAsyncPager[source]¶

Lists CloneJobs of a given migrating VM.

# 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 vmmigration_v1

async def sample_list_clone_jobs():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListCloneJobsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.ListCloneJobsRequest, dict]]) – The request object. Request message for ‘ListCloneJobsRequest’ request.
parent (str) –
Required. The parent, which owns this collection of source VMs.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ‘ListCloneJobs’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCloneJobsAsyncPager

async list_cutover_jobs(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListCutoverJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCutoverJobsAsyncPager[source]¶

Lists CutoverJobs of a given migrating VM.

# 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 vmmigration_v1

async def sample_list_cutover_jobs():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListCutoverJobsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.ListCutoverJobsRequest, dict]]) – The request object. Request message for ‘ListCutoverJobsRequest’ request.
parent (str) –
Required. The parent, which owns this collection of migrating VMs.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ‘ListCutoverJobs’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCutoverJobsAsyncPager

async list_datacenter_connectors(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListDatacenterConnectorsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListDatacenterConnectorsAsyncPager[source]¶

Lists DatacenterConnectors in a given Source.

# 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 vmmigration_v1

async def sample_list_datacenter_connectors():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListDatacenterConnectorsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.ListDatacenterConnectorsRequest, dict]]) – The request object. Request message for ‘ListDatacenterConnectors’ request.
parent (str) –
Required. The parent, which owns this collection of connectors.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ‘ListDatacenterConnectors’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListDatacenterConnectorsAsyncPager

async list_groups(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListGroupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListGroupsAsyncPager[source]¶

Lists Groups in a given project and location.

# 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 vmmigration_v1

async def sample_list_groups():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListGroupsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.ListGroupsRequest, dict]]) – The request object. Request message for ‘ListGroups’ request.
parent (str) –
Required. The parent, which owns this collection of groups.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ‘ListGroups’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListGroupsAsyncPager

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_migrating_vms(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListMigratingVmsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListMigratingVmsAsyncPager[source]¶

Lists MigratingVms in a given Source.

# 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 vmmigration_v1

async def sample_list_migrating_vms():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListMigratingVmsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.ListMigratingVmsRequest, dict]]) – The request object. Request message for ‘LisMigratingVmsRequest’ request.
parent (str) –
Required. The parent, which owns this collection of MigratingVms.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ‘ListMigratingVms’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListMigratingVmsAsyncPager

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ListOperations method.

Return type

ListOperationsResponse

async list_replication_cycles(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListReplicationCyclesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListReplicationCyclesAsyncPager[source]¶

Lists ReplicationCycles in a given MigratingVM.

# 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 vmmigration_v1

async def sample_list_replication_cycles():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListReplicationCyclesRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.ListReplicationCyclesRequest, dict]]) – The request object. Request message for ‘LisReplicationCyclesRequest’ request.
parent (str) –
Required. The parent, which owns this collection of ReplicationCycles.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ‘ListReplicationCycles’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListReplicationCyclesAsyncPager

async list_sources(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListSourcesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListSourcesAsyncPager[source]¶

Lists Sources in a given project and location.

# 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 vmmigration_v1

async def sample_list_sources():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListSourcesRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.ListSourcesRequest, dict]]) – The request object. Request message for ‘ListSources’ request.
parent (str) –
Required. The parent, which owns this collection of sources.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ‘ListSources’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListSourcesAsyncPager

async list_target_projects(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListTargetProjectsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListTargetProjectsAsyncPager[source]¶

Lists TargetProjects in a given project.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

# 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 vmmigration_v1

async def sample_list_target_projects():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListTargetProjectsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.ListTargetProjectsRequest, dict]]) – The request object. Request message for ‘ListTargetProjects’ call.
parent (str) –
Required. The parent, which owns this collection of targets.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ‘ListTargetProjects’ call. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListTargetProjectsAsyncPager

async list_utilization_reports(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListUtilizationReportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListUtilizationReportsAsyncPager[source]¶

Lists Utilization Reports of the given Source.

# 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 vmmigration_v1

async def sample_list_utilization_reports():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListUtilizationReportsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.ListUtilizationReportsRequest, dict]]) – The request object. Request message for ‘ListUtilizationReports’ request.
parent (str) –
Required. The Utilization Reports parent.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ‘ListUtilizationReports’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListUtilizationReportsAsyncPager

static migrating_vm_path(project: str, location: str, source: str, migrating_vm: str) → str¶: Returns a fully-qualified migrating_vm string.

static parse_clone_job_path(path: str) → Dict[str, str]¶: Parses a clone_job path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_cutover_job_path(path: str) → Dict[str, str]¶: Parses a cutover_job path into its component segments.

static parse_datacenter_connector_path(path: str) → Dict[str, str]¶: Parses a datacenter_connector path into its component segments.

static parse_group_path(path: str) → Dict[str, str]¶: Parses a group path into its component segments.

static parse_migrating_vm_path(path: str) → Dict[str, str]¶: Parses a migrating_vm path into its component segments.

static parse_replication_cycle_path(path: str) → Dict[str, str]¶: Parses a replication_cycle path into its component segments.

static parse_source_path(path: str) → Dict[str, str]¶: Parses a source path into its component segments.

static parse_target_project_path(path: str) → Dict[str, str]¶: Parses a target_project path into its component segments.

static parse_utilization_report_path(path: str) → Dict[str, str]¶: Parses a utilization_report path into its component segments.

async pause_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.PauseMigrationRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Pauses a migration for a VM. If cycle tasks are running they will be cancelled, preserving source task data. Further replication cycles will not be triggered while the VM is paused.

# 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 vmmigration_v1

async def sample_pause_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.PauseMigrationRequest(
        migrating_vm="migrating_vm_value",
    )

    # Make the request
    operation = client.pause_migration(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.PauseMigrationRequest, dict]]) – The request object. Request message for ‘PauseMigration’ request.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.PauseMigrationResponse Response message for ‘PauseMigration’ request.

Return type

google.api_core.operation_async.AsyncOperation

async remove_group_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.RemoveGroupMigrationRequest, dict]] = None, *, group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Removes a MigratingVm from a Group.

# 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 vmmigration_v1

async def sample_remove_group_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.RemoveGroupMigrationRequest(
        group="group_value",
    )

    # Make the request
    operation = client.remove_group_migration(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.RemoveGroupMigrationRequest, dict]]) – The request object. Request message for ‘RemoveMigration’ request.
group (str) – Required. The name of the Group. This corresponds to the group field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.RemoveGroupMigrationResponse Response message for ‘RemoveMigration’ request.

Return type

google.api_core.operation_async.AsyncOperation

static replication_cycle_path(project: str, location: str, source: str, migrating_vm: str, replication_cycle: str) → str¶: Returns a fully-qualified replication_cycle string.

async resume_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ResumeMigrationRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Resumes a migration for a VM. When called on a paused migration, will start the process of uploading data and creating snapshots; when called on a completed cut-over migration, will update the migration to active state and start the process of uploading data and creating snapshots.

# 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 vmmigration_v1

async def sample_resume_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ResumeMigrationRequest(
        migrating_vm="migrating_vm_value",
    )

    # Make the request
    operation = client.resume_migration(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.ResumeMigrationRequest, dict]]) – The request object. Request message for ‘ResumeMigration’ request.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.ResumeMigrationResponse Response message for ‘ResumeMigration’ request.

Return type

google.api_core.operation_async.AsyncOperation

static source_path(project: str, location: str, source: str) → str¶: Returns a fully-qualified source string.

async start_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.StartMigrationRequest, dict]] = None, *, migrating_vm: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Starts migration for a VM. Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy.

# 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 vmmigration_v1

async def sample_start_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.StartMigrationRequest(
        migrating_vm="migrating_vm_value",
    )

    # Make the request
    operation = client.start_migration(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.StartMigrationRequest, dict]]) – The request object. Request message for ‘StartMigrationRequest’ request.
migrating_vm (str) –
Required. The name of the MigratingVm.

This corresponds to the migrating_vm field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.StartMigrationResponse Response message for ‘StartMigration’ request.

Return type

google.api_core.operation_async.AsyncOperation

static target_project_path(project: str, location: str, target_project: str) → str¶: Returns a fully-qualified target_project string.

property transport: google.cloud.vmmigration_v1.services.vm_migration.transports.base.VmMigrationTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: VmMigrationTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_group(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.UpdateGroupRequest, dict]] = None, *, group: Optional[google.cloud.vmmigration_v1.types.vmmigration.Group] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the parameters of a single Group.

# 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 vmmigration_v1

async def sample_update_group():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.UpdateGroupRequest(
    )

    # Make the request
    operation = client.update_group(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.UpdateGroupRequest, dict]]) – The request object. Update message for ‘UpdateGroups’ request.
group (google.cloud.vmmigration_v1.types.Group) – Required. The update request body. This corresponds to the group field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the Group resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.Group Describes message for ‘Group’ resource. The Group is a collections of several: MigratingVms.

Return type

google.api_core.operation_async.AsyncOperation

async update_migrating_vm(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.UpdateMigratingVmRequest, dict]] = None, *, migrating_vm: Optional[google.cloud.vmmigration_v1.types.vmmigration.MigratingVm] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the parameters of a single MigratingVm.

# 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 vmmigration_v1

async def sample_update_migrating_vm():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.UpdateMigratingVmRequest(
    )

    # Make the request
    operation = client.update_migrating_vm(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.UpdateMigratingVmRequest, dict]]) – The request object. Request message for ‘UpdateMigratingVm’ request.
migrating_vm (google.cloud.vmmigration_v1.types.MigratingVm) – Required. The update request body. This corresponds to the migrating_vm field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the MigratingVm resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.MigratingVm MigratingVm describes the VM that will be migrated from a Source environment: and its replication state.

Return type

google.api_core.operation_async.AsyncOperation

async update_source(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.UpdateSourceRequest, dict]] = None, *, source: Optional[google.cloud.vmmigration_v1.types.vmmigration.Source] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the parameters of a single Source.

# 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 vmmigration_v1

async def sample_update_source():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.UpdateSourceRequest(
    )

    # Make the request
    operation = client.update_source(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.UpdateSourceRequest, dict]]) – The request object. Update message for ‘UpdateSources’ request.
source (google.cloud.vmmigration_v1.types.Source) – Required. The update request body. This corresponds to the source field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the Source resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.Source Source message describes a specific vm migration Source resource. It contains: the source environment information.

Return type

google.api_core.operation_async.AsyncOperation

async update_target_project(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.UpdateTargetProjectRequest, dict]] = None, *, target_project: Optional[google.cloud.vmmigration_v1.types.vmmigration.TargetProject] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the parameters of a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

# 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 vmmigration_v1

async def sample_update_target_project():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.UpdateTargetProjectRequest(
    )

    # Make the request
    operation = client.update_target_project(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.UpdateTargetProjectRequest, dict]]) – The request object. Update message for ‘UpdateTargetProject’ request.
target_project (google.cloud.vmmigration_v1.types.TargetProject) – Required. The update request body. This corresponds to the target_project field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the TargetProject resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.TargetProject TargetProject message represents a target Compute Engine project for a: migration or a clone.

Return type

google.api_core.operation_async.AsyncOperation

async upgrade_appliance(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.UpgradeApplianceRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version.

# 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 vmmigration_v1

async def sample_upgrade_appliance():
    # Create a client
    client = vmmigration_v1.VmMigrationAsyncClient()

    # Initialize request argument(s)
    request = vmmigration_v1.UpgradeApplianceRequest(
        datacenter_connector="datacenter_connector_value",
    )

    # Make the request
    operation = client.upgrade_appliance(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.vmmigration_v1.types.UpgradeApplianceRequest, dict]]) – The request object. Request message for ‘UpgradeAppliance’ request.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.UpgradeApplianceResponse Response message for ‘UpgradeAppliance’ request.

Return type

google.api_core.operation_async.AsyncOperation

static utilization_report_path(project: str, location: str, source: str, utilization_report: str) → str¶: Returns a fully-qualified utilization_report string.

class google.cloud.vmmigration_v1.services.vm_migration.VmMigrationClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.vmmigration_v1.services.vm_migration.transports.base.VmMigrationTransport, typing.Callable[[...], google.cloud.vmmigration_v1.services.vm_migration.transports.base.VmMigrationTransport]]] = 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>)[source]¶

VM Migration Service

Instantiates the vm migration client.

Parameters

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 (Optional[Union[str,VmMigrationTransport,Callable[..., VmMigrationTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the VmMigrationTransport constructor. 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

add_group_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.AddGroupMigrationRequest, dict]] = None, *, group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Adds a MigratingVm to a Group.

# 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 vmmigration_v1

def sample_add_group_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.AddGroupMigrationRequest(
        group="group_value",
    )

    # Make the request
    operation = client.add_group_migration(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.AddGroupMigrationRequest, dict]) – The request object. Request message for ‘AddGroupMigration’ request.
group (str) –
Required. The full path name of the Group to add to.

This corresponds to the group 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.AddGroupMigrationResponse Response message for ‘AddGroupMigration’ request.

Return type

google.api_core.operation.Operation

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

cancel_clone_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CancelCloneJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Initiates the cancellation of a running clone job.

# 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 vmmigration_v1

def sample_cancel_clone_job():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CancelCloneJobRequest(
        name="name_value",
    )

    # Make the request
    operation = client.cancel_clone_job(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.CancelCloneJobRequest, dict]) – The request object. Request message for ‘CancelCloneJob’ request.
name (str) – Required. The clone job id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.CancelCloneJobResponse Response message for ‘CancelCloneJob’ request.

Return type

google.api_core.operation.Operation

cancel_cutover_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CancelCutoverJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Initiates the cancellation of a running cutover job.

# 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 vmmigration_v1

def sample_cancel_cutover_job():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CancelCutoverJobRequest(
        name="name_value",
    )

    # Make the request
    operation = client.cancel_cutover_job(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.CancelCutoverJobRequest, dict]) – The request object. Request message for ‘CancelCutoverJob’ request.
name (str) – Required. The cutover job id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.CancelCutoverJobResponse Response message for ‘CancelCutoverJob’ request.

Return type

google.api_core.operation.Operation

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (CancelOperationRequest) – The request object. Request message for CancelOperation method.
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

None

static clone_job_path(project: str, location: str, source: str, migrating_vm: str, clone_job: str) → str[source]¶: Returns a fully-qualified clone_job string.

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_clone_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateCloneJobRequest, dict]] = None, *, parent: Optional[str] = None, clone_job: Optional[google.cloud.vmmigration_v1.types.vmmigration.CloneJob] = None, clone_job_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Initiates a Clone of a specific migrating VM.

# 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 vmmigration_v1

def sample_create_clone_job():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateCloneJobRequest(
        parent="parent_value",
        clone_job_id="clone_job_id_value",
    )

    # Make the request
    operation = client.create_clone_job(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.CreateCloneJobRequest, dict]) – The request object. Request message for ‘CreateCloneJob’ request.
parent (str) – Required. The Clone’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
clone_job (google.cloud.vmmigration_v1.types.CloneJob) – Required. The clone request body. This corresponds to the clone_job field on the request instance; if request is provided, this should not be set.
clone_job_id (str) – Required. The clone job identifier. This corresponds to the clone_job_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.CloneJob CloneJob describes the process of creating a clone of a: [MigratingVM][google.cloud.vmmigration.v1.MigratingVm] to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone.

Return type

google.api_core.operation.Operation

create_cutover_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateCutoverJobRequest, dict]] = None, *, parent: Optional[str] = None, cutover_job: Optional[google.cloud.vmmigration_v1.types.vmmigration.CutoverJob] = None, cutover_job_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Initiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.

# 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 vmmigration_v1

def sample_create_cutover_job():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateCutoverJobRequest(
        parent="parent_value",
        cutover_job_id="cutover_job_id_value",
    )

    # Make the request
    operation = client.create_cutover_job(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.CreateCutoverJobRequest, dict]) – The request object. Request message for ‘CreateCutoverJob’ request.
parent (str) – Required. The Cutover’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
cutover_job (google.cloud.vmmigration_v1.types.CutoverJob) – Required. The cutover request body. This corresponds to the cutover_job field on the request instance; if request is provided, this should not be set.
cutover_job_id (str) – Required. The cutover job identifier. This corresponds to the cutover_job_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.CutoverJob CutoverJob message describes a cutover of a migrating VM. The CutoverJob is: the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.

Return type

google.api_core.operation.Operation

create_datacenter_connector(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateDatacenterConnectorRequest, dict]] = None, *, parent: Optional[str] = None, datacenter_connector: Optional[google.cloud.vmmigration_v1.types.vmmigration.DatacenterConnector] = None, datacenter_connector_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new DatacenterConnector in a given Source.

# 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 vmmigration_v1

def sample_create_datacenter_connector():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateDatacenterConnectorRequest(
        parent="parent_value",
        datacenter_connector_id="datacenter_connector_id_value",
    )

    # Make the request
    operation = client.create_datacenter_connector(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.CreateDatacenterConnectorRequest, dict]) – The request object. Request message for ‘CreateDatacenterConnector’ request.
parent (str) –
Required. The DatacenterConnector’s parent. Required. The Source in where the new DatacenterConnector will be created. For example: projects/my-project/locations/us-central1/sources/my-source

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
datacenter_connector (google.cloud.vmmigration_v1.types.DatacenterConnector) – Required. The create request body. This corresponds to the datacenter_connector field on the request instance; if request is provided, this should not be set.
datacenter_connector_id (str) –
Required. The datacenterConnector identifier.

This corresponds to the datacenter_connector_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.DatacenterConnector DatacenterConnector message describes a connector between the Source and: Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer.

Return type

google.api_core.operation.Operation

create_group(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateGroupRequest, dict]] = None, *, parent: Optional[str] = None, group: Optional[google.cloud.vmmigration_v1.types.vmmigration.Group] = None, group_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new Group in a given project and location.

# 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 vmmigration_v1

def sample_create_group():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateGroupRequest(
        parent="parent_value",
        group_id="group_id_value",
    )

    # Make the request
    operation = client.create_group(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.CreateGroupRequest, dict]) – The request object. Request message for ‘CreateGroup’ request.
parent (str) – Required. The Group’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
group (google.cloud.vmmigration_v1.types.Group) – Required. The create request body. This corresponds to the group field on the request instance; if request is provided, this should not be set.
group_id (str) – Required. The group identifier. This corresponds to the group_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.Group Describes message for ‘Group’ resource. The Group is a collections of several: MigratingVms.

Return type

google.api_core.operation.Operation

create_migrating_vm(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateMigratingVmRequest, dict]] = None, *, parent: Optional[str] = None, migrating_vm: Optional[google.cloud.vmmigration_v1.types.vmmigration.MigratingVm] = None, migrating_vm_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new MigratingVm in a given Source.

# 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 vmmigration_v1

def sample_create_migrating_vm():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateMigratingVmRequest(
        parent="parent_value",
        migrating_vm_id="migrating_vm_id_value",
    )

    # Make the request
    operation = client.create_migrating_vm(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.CreateMigratingVmRequest, dict]) – The request object. Request message for ‘CreateMigratingVm’ request.
parent (str) – Required. The MigratingVm’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
migrating_vm (google.cloud.vmmigration_v1.types.MigratingVm) – Required. The create request body. This corresponds to the migrating_vm field on the request instance; if request is provided, this should not be set.
migrating_vm_id (str) – Required. The migratingVm identifier. This corresponds to the migrating_vm_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.MigratingVm MigratingVm describes the VM that will be migrated from a Source environment: and its replication state.

Return type

google.api_core.operation.Operation

create_source(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateSourceRequest, dict]] = None, *, parent: Optional[str] = None, source: Optional[google.cloud.vmmigration_v1.types.vmmigration.Source] = None, source_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new Source in a given project and location.

# 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 vmmigration_v1

def sample_create_source():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateSourceRequest(
        parent="parent_value",
        source_id="source_id_value",
    )

    # Make the request
    operation = client.create_source(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.CreateSourceRequest, dict]) – The request object. Request message for ‘CreateSource’ request.
parent (str) – Required. The Source’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
source (google.cloud.vmmigration_v1.types.Source) – Required. The create request body. This corresponds to the source field on the request instance; if request is provided, this should not be set.
source_id (str) – Required. The source identifier. This corresponds to the source_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.Source Source message describes a specific vm migration Source resource. It contains: the source environment information.

Return type

google.api_core.operation.Operation

create_target_project(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateTargetProjectRequest, dict]] = None, *, parent: Optional[str] = None, target_project: Optional[google.cloud.vmmigration_v1.types.vmmigration.TargetProject] = None, target_project_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new TargetProject in a given project.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

# 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 vmmigration_v1

def sample_create_target_project():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateTargetProjectRequest(
        parent="parent_value",
        target_project_id="target_project_id_value",
    )

    # Make the request
    operation = client.create_target_project(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.CreateTargetProjectRequest, dict]) – The request object. Request message for ‘CreateTargetProject’ request.
parent (str) – Required. The TargetProject’s parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
target_project (google.cloud.vmmigration_v1.types.TargetProject) – Required. The create request body. This corresponds to the target_project field on the request instance; if request is provided, this should not be set.
target_project_id (str) – Required. The target_project identifier. This corresponds to the target_project_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.TargetProject TargetProject message represents a target Compute Engine project for a: migration or a clone.

Return type

google.api_core.operation.Operation

create_utilization_report(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.CreateUtilizationReportRequest, dict]] = None, *, parent: Optional[str] = None, utilization_report: Optional[google.cloud.vmmigration_v1.types.vmmigration.UtilizationReport] = None, utilization_report_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new UtilizationReport.

# 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 vmmigration_v1

def sample_create_utilization_report():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.CreateUtilizationReportRequest(
        parent="parent_value",
        utilization_report_id="utilization_report_id_value",
    )

    # Make the request
    operation = client.create_utilization_report(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.CreateUtilizationReportRequest, dict]) – The request object. Request message for ‘CreateUtilizationReport’ request.
parent (str) –
Required. The Utilization Report’s parent.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
utilization_report (google.cloud.vmmigration_v1.types.UtilizationReport) – Required. The report to create. This corresponds to the utilization_report field on the request instance; if request is provided, this should not be set.
utilization_report_id (str) –
Required. The ID to use for the report, which will become the final component of the reports’s resource name.

This value maximum length is 63 characters, and valid characters are /[a-z][0-9]-/. It must start with an english letter and must not end with a hyphen.

This corresponds to the utilization_report_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.UtilizationReport Utilization report details the utilization (CPU, memory, etc.) of selected: source VMs.

Return type

google.api_core.operation.Operation

static cutover_job_path(project: str, location: str, source: str, migrating_vm: str, cutover_job: str) → str[source]¶: Returns a fully-qualified cutover_job string.

static datacenter_connector_path(project: str, location: str, source: str, datacenter_connector: str) → str[source]¶: Returns a fully-qualified datacenter_connector string.

delete_datacenter_connector(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteDatacenterConnectorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single DatacenterConnector.

# 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 vmmigration_v1

def sample_delete_datacenter_connector():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteDatacenterConnectorRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_datacenter_connector(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.DeleteDatacenterConnectorRequest, dict]) – The request object. Request message for ‘DeleteDatacenterConnector’ request.
name (str) –
Required. The DatacenterConnector name.

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

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:

Return type

google.api_core.operation.Operation

delete_group(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteGroupRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single Group.

# 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 vmmigration_v1

def sample_delete_group():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteGroupRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_group(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.DeleteGroupRequest, dict]) – The request object. Request message for ‘DeleteGroup’ request.
name (str) – Required. The Group name. 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

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:

Return type

google.api_core.operation.Operation

delete_migrating_vm(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteMigratingVmRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single MigratingVm.

# 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 vmmigration_v1

def sample_delete_migrating_vm():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteMigratingVmRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_migrating_vm(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.DeleteMigratingVmRequest, dict]) – The request object. Request message for ‘DeleteMigratingVm’ request.
name (str) –
Required. The name of the MigratingVm.

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

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:

Return type

google.api_core.operation.Operation

delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.
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

None

delete_source(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteSourceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single Source.

# 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 vmmigration_v1

def sample_delete_source():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteSourceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_source(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.DeleteSourceRequest, dict]) – The request object. Request message for ‘DeleteSource’ request.
name (str) – Required. The Source name. 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

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:

Return type

google.api_core.operation.Operation

delete_target_project(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteTargetProjectRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

# 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 vmmigration_v1

def sample_delete_target_project():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteTargetProjectRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_target_project(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.DeleteTargetProjectRequest, dict]) – The request object. Request message for ‘DeleteTargetProject’ request.
name (str) – Required. The TargetProject name. 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

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:

Return type

google.api_core.operation.Operation

delete_utilization_report(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.DeleteUtilizationReportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single Utilization Report.

# 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 vmmigration_v1

def sample_delete_utilization_report():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.DeleteUtilizationReportRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_utilization_report(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.DeleteUtilizationReportRequest, dict]) – The request object. Request message for ‘DeleteUtilizationReport’ request.
name (str) –
Required. The Utilization Report name.

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

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:

Return type

google.api_core.operation.Operation

fetch_inventory(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.FetchInventoryRequest, dict]] = None, *, source: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.FetchInventoryResponse[source]¶

List remote source’s inventory of VMs. The remote source is the onprem vCenter (remote in the sense it’s not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.

# 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 vmmigration_v1

def sample_fetch_inventory():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.FetchInventoryRequest(
        source="source_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.FetchInventoryRequest, dict]) – The request object. Request message for [fetchInventory][google.cloud.vmmigration.v1.VmMigration.FetchInventory].
source (str) – Required. The name of the Source. This corresponds to the source 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

Response message for: [fetchInventory][google.cloud.vmmigration.v1.VmMigration.FetchInventory].

Return type

google.cloud.vmmigration_v1.types.FetchInventoryResponse

finalize_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.FinalizeMigrationRequest, dict]] = None, *, migrating_vm: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Marks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done.

# 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 vmmigration_v1

def sample_finalize_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.FinalizeMigrationRequest(
        migrating_vm="migrating_vm_value",
    )

    # Make the request
    operation = client.finalize_migration(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.FinalizeMigrationRequest, dict]) – The request object. Request message for ‘FinalizeMigration’ request.
migrating_vm (str) –
Required. The name of the MigratingVm.

This corresponds to the migrating_vm 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.FinalizeMigrationResponse Response message for ‘FinalizeMigration’ request.

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VmMigrationClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VmMigrationClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VmMigrationClient

get_clone_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetCloneJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.CloneJob[source]¶

Gets details of a single CloneJob.

# 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 vmmigration_v1

def sample_get_clone_job():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetCloneJobRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.GetCloneJobRequest, dict]) – The request object. Request message for ‘GetCloneJob’ request.
name (str) – Required. The name of the CloneJob. 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

CloneJob describes the process of creating a clone of a: [MigratingVM][google.cloud.vmmigration.v1.MigratingVm] to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone.

Return type

google.cloud.vmmigration_v1.types.CloneJob

get_cutover_job(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetCutoverJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.CutoverJob[source]¶

Gets details of a single CutoverJob.

# 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 vmmigration_v1

def sample_get_cutover_job():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetCutoverJobRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.GetCutoverJobRequest, dict]) – The request object. Request message for ‘GetCutoverJob’ request.
name (str) – Required. The name of the CutoverJob. 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

CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.

Return type

google.cloud.vmmigration_v1.types.CutoverJob

get_datacenter_connector(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetDatacenterConnectorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.DatacenterConnector[source]¶

Gets details of a single DatacenterConnector.

# 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 vmmigration_v1

def sample_get_datacenter_connector():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetDatacenterConnectorRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.GetDatacenterConnectorRequest, dict]) – The request object. Request message for ‘GetDatacenterConnector’ request.
name (str) –
Required. The name of the DatacenterConnector.

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

DatacenterConnector message describes a connector between the Source and Google Cloud, which is installed on a vmware datacenter (an OVA vm installed by the user) to connect the Datacenter to Google Cloud and support vm migration data transfer.

Return type

google.cloud.vmmigration_v1.types.DatacenterConnector

get_group(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetGroupRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.Group[source]¶

Gets details of a single Group.

# 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 vmmigration_v1

def sample_get_group():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetGroupRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.GetGroupRequest, dict]) – The request object. Request message for ‘GetGroup’ request.
name (str) – Required. The group name. 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

Describes message for ‘Group’ resource. The Group is a collections of several MigratingVms.

Return type

google.cloud.vmmigration_v1.types.Group

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
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

Location object.

Return type

Location

get_migrating_vm(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetMigratingVmRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.MigratingVm[source]¶

Gets details of a single MigratingVm.

# 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 vmmigration_v1

def sample_get_migrating_vm():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetMigratingVmRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.GetMigratingVmRequest, dict]) – The request object. Request message for ‘GetMigratingVm’ request.
name (str) –
Required. The name of the MigratingVm.

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

MigratingVm describes the VM that will be migrated from a Source environment and its replication state.

Return type

google.cloud.vmmigration_v1.types.MigratingVm

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
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

An Operation object.

Return type

Operation

get_replication_cycle(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetReplicationCycleRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.ReplicationCycle[source]¶

Gets details of a single ReplicationCycle.

# 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 vmmigration_v1

def sample_get_replication_cycle():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetReplicationCycleRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.GetReplicationCycleRequest, dict]) – The request object. Request message for ‘GetReplicationCycle’ request.
name (str) –
Required. The name of the ReplicationCycle.

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

ReplicationCycle contains information about the current replication cycle status.

Return type

google.cloud.vmmigration_v1.types.ReplicationCycle

get_source(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetSourceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.Source[source]¶

Gets details of a single Source.

# 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 vmmigration_v1

def sample_get_source():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetSourceRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.GetSourceRequest, dict]) – The request object. Request message for ‘GetSource’ request.
name (str) – Required. The Source name. 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

Source message describes a specific vm migration Source resource. It contains the source environment information.

Return type

google.cloud.vmmigration_v1.types.Source

get_target_project(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetTargetProjectRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.TargetProject[source]¶

Gets details of a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

# 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 vmmigration_v1

def sample_get_target_project():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetTargetProjectRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.GetTargetProjectRequest, dict]) – The request object. Request message for ‘GetTargetProject’ call.
name (str) – Required. The TargetProject name. 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

TargetProject message represents a target Compute Engine project for a migration or a clone.

Return type

google.cloud.vmmigration_v1.types.TargetProject

get_utilization_report(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.GetUtilizationReportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.types.vmmigration.UtilizationReport[source]¶

Gets a single Utilization Report.

# 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 vmmigration_v1

def sample_get_utilization_report():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.GetUtilizationReportRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.GetUtilizationReportRequest, dict]) – The request object. Request message for ‘GetUtilizationReport’ request.
name (str) –
Required. The Utilization Report name.

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

Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.

Return type

google.cloud.vmmigration_v1.types.UtilizationReport

static group_path(project: str, location: str, group: str) → str[source]¶: Returns a fully-qualified group string.

list_clone_jobs(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListCloneJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCloneJobsPager[source]¶

Lists CloneJobs of a given migrating VM.

# 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 vmmigration_v1

def sample_list_clone_jobs():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListCloneJobsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Union[google.cloud.vmmigration_v1.types.ListCloneJobsRequest, dict]) – The request object. Request message for ‘ListCloneJobsRequest’ request.
parent (str) –
Required. The parent, which owns this collection of source VMs.

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

Response message for ‘ListCloneJobs’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCloneJobsPager

list_cutover_jobs(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListCutoverJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCutoverJobsPager[source]¶

Lists CutoverJobs of a given migrating VM.

# 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 vmmigration_v1

def sample_list_cutover_jobs():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListCutoverJobsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Union[google.cloud.vmmigration_v1.types.ListCutoverJobsRequest, dict]) – The request object. Request message for ‘ListCutoverJobsRequest’ request.
parent (str) –
Required. The parent, which owns this collection of migrating VMs.

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

Response message for ‘ListCutoverJobs’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCutoverJobsPager

list_datacenter_connectors(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListDatacenterConnectorsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListDatacenterConnectorsPager[source]¶

Lists DatacenterConnectors in a given Source.

# 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 vmmigration_v1

def sample_list_datacenter_connectors():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListDatacenterConnectorsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Union[google.cloud.vmmigration_v1.types.ListDatacenterConnectorsRequest, dict]) – The request object. Request message for ‘ListDatacenterConnectors’ request.
parent (str) –
Required. The parent, which owns this collection of connectors.

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

Response message for ‘ListDatacenterConnectors’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListDatacenterConnectorsPager

list_groups(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListGroupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListGroupsPager[source]¶

Lists Groups in a given project and location.

# 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 vmmigration_v1

def sample_list_groups():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListGroupsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Union[google.cloud.vmmigration_v1.types.ListGroupsRequest, dict]) – The request object. Request message for ‘ListGroups’ request.
parent (str) –
Required. The parent, which owns this collection of groups.

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

Response message for ‘ListGroups’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListGroupsPager

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
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

Response message for ListLocations method.

Return type

ListLocationsResponse

list_migrating_vms(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListMigratingVmsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListMigratingVmsPager[source]¶

Lists MigratingVms in a given Source.

# 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 vmmigration_v1

def sample_list_migrating_vms():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListMigratingVmsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Union[google.cloud.vmmigration_v1.types.ListMigratingVmsRequest, dict]) – The request object. Request message for ‘LisMigratingVmsRequest’ request.
parent (str) –
Required. The parent, which owns this collection of MigratingVms.

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

Response message for ‘ListMigratingVms’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListMigratingVmsPager

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
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

Response message for ListOperations method.

Return type

ListOperationsResponse

list_replication_cycles(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListReplicationCyclesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListReplicationCyclesPager[source]¶

Lists ReplicationCycles in a given MigratingVM.

# 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 vmmigration_v1

def sample_list_replication_cycles():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListReplicationCyclesRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Union[google.cloud.vmmigration_v1.types.ListReplicationCyclesRequest, dict]) – The request object. Request message for ‘LisReplicationCyclesRequest’ request.
parent (str) –
Required. The parent, which owns this collection of ReplicationCycles.

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

Response message for ‘ListReplicationCycles’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListReplicationCyclesPager

list_sources(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListSourcesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListSourcesPager[source]¶

Lists Sources in a given project and location.

# 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 vmmigration_v1

def sample_list_sources():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListSourcesRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Union[google.cloud.vmmigration_v1.types.ListSourcesRequest, dict]) – The request object. Request message for ‘ListSources’ request.
parent (str) –
Required. The parent, which owns this collection of sources.

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

Response message for ‘ListSources’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListSourcesPager

list_target_projects(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListTargetProjectsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListTargetProjectsPager[source]¶

Lists TargetProjects in a given project.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

# 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 vmmigration_v1

def sample_list_target_projects():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListTargetProjectsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Union[google.cloud.vmmigration_v1.types.ListTargetProjectsRequest, dict]) – The request object. Request message for ‘ListTargetProjects’ call.
parent (str) –
Required. The parent, which owns this collection of targets.

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

Response message for ‘ListTargetProjects’ call. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListTargetProjectsPager

list_utilization_reports(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ListUtilizationReportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.vmmigration_v1.services.vm_migration.pagers.ListUtilizationReportsPager[source]¶

Lists Utilization Reports of the given Source.

# 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 vmmigration_v1

def sample_list_utilization_reports():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ListUtilizationReportsRequest(
        parent="parent_value",
        page_token="page_token_value",
    )

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

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

Parameters

request (Union[google.cloud.vmmigration_v1.types.ListUtilizationReportsRequest, dict]) – The request object. Request message for ‘ListUtilizationReports’ request.
parent (str) –
Required. The Utilization Reports parent.

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

Response message for ‘ListUtilizationReports’ request. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.vmmigration_v1.services.vm_migration.pagers.ListUtilizationReportsPager

static migrating_vm_path(project: str, location: str, source: str, migrating_vm: str) → str[source]¶: Returns a fully-qualified migrating_vm string.

static parse_clone_job_path(path: str) → Dict[str, str][source]¶: Parses a clone_job path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_cutover_job_path(path: str) → Dict[str, str][source]¶: Parses a cutover_job path into its component segments.

static parse_datacenter_connector_path(path: str) → Dict[str, str][source]¶: Parses a datacenter_connector path into its component segments.

static parse_group_path(path: str) → Dict[str, str][source]¶: Parses a group path into its component segments.

static parse_migrating_vm_path(path: str) → Dict[str, str][source]¶: Parses a migrating_vm path into its component segments.

static parse_replication_cycle_path(path: str) → Dict[str, str][source]¶: Parses a replication_cycle path into its component segments.

static parse_source_path(path: str) → Dict[str, str][source]¶: Parses a source path into its component segments.

static parse_target_project_path(path: str) → Dict[str, str][source]¶: Parses a target_project path into its component segments.

static parse_utilization_report_path(path: str) → Dict[str, str][source]¶: Parses a utilization_report path into its component segments.

pause_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.PauseMigrationRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Pauses a migration for a VM. If cycle tasks are running they will be cancelled, preserving source task data. Further replication cycles will not be triggered while the VM is paused.

# 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 vmmigration_v1

def sample_pause_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.PauseMigrationRequest(
        migrating_vm="migrating_vm_value",
    )

    # Make the request
    operation = client.pause_migration(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.PauseMigrationRequest, dict]) – The request object. Request message for ‘PauseMigration’ request.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.PauseMigrationResponse Response message for ‘PauseMigration’ request.

Return type

google.api_core.operation.Operation

remove_group_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.RemoveGroupMigrationRequest, dict]] = None, *, group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Removes a MigratingVm from a Group.

# 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 vmmigration_v1

def sample_remove_group_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.RemoveGroupMigrationRequest(
        group="group_value",
    )

    # Make the request
    operation = client.remove_group_migration(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.RemoveGroupMigrationRequest, dict]) – The request object. Request message for ‘RemoveMigration’ request.
group (str) – Required. The name of the Group. This corresponds to the group 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.RemoveGroupMigrationResponse Response message for ‘RemoveMigration’ request.

Return type

google.api_core.operation.Operation

static replication_cycle_path(project: str, location: str, source: str, migrating_vm: str, replication_cycle: str) → str[source]¶: Returns a fully-qualified replication_cycle string.

resume_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.ResumeMigrationRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Resumes a migration for a VM. When called on a paused migration, will start the process of uploading data and creating snapshots; when called on a completed cut-over migration, will update the migration to active state and start the process of uploading data and creating snapshots.

# 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 vmmigration_v1

def sample_resume_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.ResumeMigrationRequest(
        migrating_vm="migrating_vm_value",
    )

    # Make the request
    operation = client.resume_migration(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.ResumeMigrationRequest, dict]) – The request object. Request message for ‘ResumeMigration’ request.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.ResumeMigrationResponse Response message for ‘ResumeMigration’ request.

Return type

google.api_core.operation.Operation

static source_path(project: str, location: str, source: str) → str[source]¶: Returns a fully-qualified source string.

start_migration(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.StartMigrationRequest, dict]] = None, *, migrating_vm: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Starts migration for a VM. Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy.

# 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 vmmigration_v1

def sample_start_migration():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.StartMigrationRequest(
        migrating_vm="migrating_vm_value",
    )

    # Make the request
    operation = client.start_migration(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.StartMigrationRequest, dict]) – The request object. Request message for ‘StartMigrationRequest’ request.
migrating_vm (str) –
Required. The name of the MigratingVm.

This corresponds to the migrating_vm 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.StartMigrationResponse Response message for ‘StartMigration’ request.

Return type

google.api_core.operation.Operation

static target_project_path(project: str, location: str, target_project: str) → str[source]¶: Returns a fully-qualified target_project string.

property transport: google.cloud.vmmigration_v1.services.vm_migration.transports.base.VmMigrationTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

VmMigrationTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_group(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.UpdateGroupRequest, dict]] = None, *, group: Optional[google.cloud.vmmigration_v1.types.vmmigration.Group] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the parameters of a single Group.

# 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 vmmigration_v1

def sample_update_group():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.UpdateGroupRequest(
    )

    # Make the request
    operation = client.update_group(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.UpdateGroupRequest, dict]) – The request object. Update message for ‘UpdateGroups’ request.
group (google.cloud.vmmigration_v1.types.Group) – Required. The update request body. This corresponds to the group field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the Group resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.Group Describes message for ‘Group’ resource. The Group is a collections of several: MigratingVms.

Return type

google.api_core.operation.Operation

update_migrating_vm(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.UpdateMigratingVmRequest, dict]] = None, *, migrating_vm: Optional[google.cloud.vmmigration_v1.types.vmmigration.MigratingVm] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the parameters of a single MigratingVm.

# 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 vmmigration_v1

def sample_update_migrating_vm():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.UpdateMigratingVmRequest(
    )

    # Make the request
    operation = client.update_migrating_vm(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.UpdateMigratingVmRequest, dict]) – The request object. Request message for ‘UpdateMigratingVm’ request.
migrating_vm (google.cloud.vmmigration_v1.types.MigratingVm) – Required. The update request body. This corresponds to the migrating_vm field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the MigratingVm resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.MigratingVm MigratingVm describes the VM that will be migrated from a Source environment: and its replication state.

Return type

google.api_core.operation.Operation

update_source(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.UpdateSourceRequest, dict]] = None, *, source: Optional[google.cloud.vmmigration_v1.types.vmmigration.Source] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the parameters of a single Source.

# 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 vmmigration_v1

def sample_update_source():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.UpdateSourceRequest(
    )

    # Make the request
    operation = client.update_source(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.UpdateSourceRequest, dict]) – The request object. Update message for ‘UpdateSources’ request.
source (google.cloud.vmmigration_v1.types.Source) – Required. The update request body. This corresponds to the source field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the Source resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.Source Source message describes a specific vm migration Source resource. It contains: the source environment information.

Return type

google.api_core.operation.Operation

update_target_project(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.UpdateTargetProjectRequest, dict]] = None, *, target_project: Optional[google.cloud.vmmigration_v1.types.vmmigration.TargetProject] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the parameters of a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

# 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 vmmigration_v1

def sample_update_target_project():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.UpdateTargetProjectRequest(
    )

    # Make the request
    operation = client.update_target_project(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.UpdateTargetProjectRequest, dict]) – The request object. Update message for ‘UpdateTargetProject’ request.
target_project (google.cloud.vmmigration_v1.types.TargetProject) – Required. The update request body. This corresponds to the target_project field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the TargetProject resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.TargetProject TargetProject message represents a target Compute Engine project for a: migration or a clone.

Return type

google.api_core.operation.Operation

upgrade_appliance(request: Optional[Union[google.cloud.vmmigration_v1.types.vmmigration.UpgradeApplianceRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version.

# 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 vmmigration_v1

def sample_upgrade_appliance():
    # Create a client
    client = vmmigration_v1.VmMigrationClient()

    # Initialize request argument(s)
    request = vmmigration_v1.UpgradeApplianceRequest(
        datacenter_connector="datacenter_connector_value",
    )

    # Make the request
    operation = client.upgrade_appliance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.vmmigration_v1.types.UpgradeApplianceRequest, dict]) – The request object. Request message for ‘UpgradeAppliance’ request.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.vmmigration_v1.types.UpgradeApplianceResponse Response message for ‘UpgradeAppliance’ request.

Return type

google.api_core.operation.Operation

static utilization_report_path(project: str, location: str, source: str, utilization_report: str) → str[source]¶: Returns a fully-qualified utilization_report string.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCloneJobsAsyncPager(method: Callable[[...], Awaitable[google.cloud.vmmigration_v1.types.vmmigration.ListCloneJobsResponse]], request: google.cloud.vmmigration_v1.types.vmmigration.ListCloneJobsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListCloneJobsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_clone_jobs requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListCloneJobsResponse object, and provides an __aiter__ method to iterate through its clone_jobs field.

If there are more pages, the __aiter__ method will make additional ListCloneJobs requests and continue to iterate through the clone_jobs field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListCloneJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListCloneJobsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListCloneJobsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCloneJobsPager(method: Callable[[...], google.cloud.vmmigration_v1.types.vmmigration.ListCloneJobsResponse], request: google.cloud.vmmigration_v1.types.vmmigration.ListCloneJobsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListCloneJobsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_clone_jobs requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListCloneJobsResponse object, and provides an __iter__ method to iterate through its clone_jobs field.

If there are more pages, the __iter__ method will make additional ListCloneJobs requests and continue to iterate through the clone_jobs field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListCloneJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListCloneJobsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListCloneJobsResponse) – The initial response object.
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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCutoverJobsAsyncPager(method: Callable[[...], Awaitable[google.cloud.vmmigration_v1.types.vmmigration.ListCutoverJobsResponse]], request: google.cloud.vmmigration_v1.types.vmmigration.ListCutoverJobsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListCutoverJobsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_cutover_jobs requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListCutoverJobsResponse object, and provides an __aiter__ method to iterate through its cutover_jobs field.

If there are more pages, the __aiter__ method will make additional ListCutoverJobs requests and continue to iterate through the cutover_jobs field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListCutoverJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListCutoverJobsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListCutoverJobsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListCutoverJobsPager(method: Callable[[...], google.cloud.vmmigration_v1.types.vmmigration.ListCutoverJobsResponse], request: google.cloud.vmmigration_v1.types.vmmigration.ListCutoverJobsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListCutoverJobsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_cutover_jobs requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListCutoverJobsResponse object, and provides an __iter__ method to iterate through its cutover_jobs field.

If there are more pages, the __iter__ method will make additional ListCutoverJobs requests and continue to iterate through the cutover_jobs field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListCutoverJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListCutoverJobsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListCutoverJobsResponse) – The initial response object.
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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListDatacenterConnectorsAsyncPager(method: Callable[[...], Awaitable[google.cloud.vmmigration_v1.types.vmmigration.ListDatacenterConnectorsResponse]], request: google.cloud.vmmigration_v1.types.vmmigration.ListDatacenterConnectorsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListDatacenterConnectorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_datacenter_connectors requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListDatacenterConnectorsResponse object, and provides an __aiter__ method to iterate through its datacenter_connectors field.

If there are more pages, the __aiter__ method will make additional ListDatacenterConnectors requests and continue to iterate through the datacenter_connectors field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListDatacenterConnectorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListDatacenterConnectorsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListDatacenterConnectorsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListDatacenterConnectorsPager(method: Callable[[...], google.cloud.vmmigration_v1.types.vmmigration.ListDatacenterConnectorsResponse], request: google.cloud.vmmigration_v1.types.vmmigration.ListDatacenterConnectorsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListDatacenterConnectorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_datacenter_connectors requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListDatacenterConnectorsResponse object, and provides an __iter__ method to iterate through its datacenter_connectors field.

If there are more pages, the __iter__ method will make additional ListDatacenterConnectors requests and continue to iterate through the datacenter_connectors field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListDatacenterConnectorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListDatacenterConnectorsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListDatacenterConnectorsResponse) – The initial response object.
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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListGroupsAsyncPager(method: Callable[[...], Awaitable[google.cloud.vmmigration_v1.types.vmmigration.ListGroupsResponse]], request: google.cloud.vmmigration_v1.types.vmmigration.ListGroupsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListGroupsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_groups requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListGroupsResponse object, and provides an __aiter__ method to iterate through its groups field.

If there are more pages, the __aiter__ method will make additional ListGroups requests and continue to iterate through the groups field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListGroupsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListGroupsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListGroupsPager(method: Callable[[...], google.cloud.vmmigration_v1.types.vmmigration.ListGroupsResponse], request: google.cloud.vmmigration_v1.types.vmmigration.ListGroupsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListGroupsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_groups requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListGroupsResponse object, and provides an __iter__ method to iterate through its groups field.

If there are more pages, the __iter__ method will make additional ListGroups requests and continue to iterate through the groups field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListGroupsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListGroupsResponse) – The initial response object.
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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListMigratingVmsAsyncPager(method: Callable[[...], Awaitable[google.cloud.vmmigration_v1.types.vmmigration.ListMigratingVmsResponse]], request: google.cloud.vmmigration_v1.types.vmmigration.ListMigratingVmsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListMigratingVmsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_migrating_vms requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListMigratingVmsResponse object, and provides an __aiter__ method to iterate through its migrating_vms field.

If there are more pages, the __aiter__ method will make additional ListMigratingVms requests and continue to iterate through the migrating_vms field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListMigratingVmsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListMigratingVmsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListMigratingVmsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListMigratingVmsPager(method: Callable[[...], google.cloud.vmmigration_v1.types.vmmigration.ListMigratingVmsResponse], request: google.cloud.vmmigration_v1.types.vmmigration.ListMigratingVmsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListMigratingVmsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_migrating_vms requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListMigratingVmsResponse object, and provides an __iter__ method to iterate through its migrating_vms field.

If there are more pages, the __iter__ method will make additional ListMigratingVms requests and continue to iterate through the migrating_vms field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListMigratingVmsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListMigratingVmsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListMigratingVmsResponse) – The initial response object.
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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListReplicationCyclesAsyncPager(method: Callable[[...], Awaitable[google.cloud.vmmigration_v1.types.vmmigration.ListReplicationCyclesResponse]], request: google.cloud.vmmigration_v1.types.vmmigration.ListReplicationCyclesRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListReplicationCyclesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_replication_cycles requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListReplicationCyclesResponse object, and provides an __aiter__ method to iterate through its replication_cycles field.

If there are more pages, the __aiter__ method will make additional ListReplicationCycles requests and continue to iterate through the replication_cycles field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListReplicationCyclesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListReplicationCyclesRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListReplicationCyclesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListReplicationCyclesPager(method: Callable[[...], google.cloud.vmmigration_v1.types.vmmigration.ListReplicationCyclesResponse], request: google.cloud.vmmigration_v1.types.vmmigration.ListReplicationCyclesRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListReplicationCyclesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_replication_cycles requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListReplicationCyclesResponse object, and provides an __iter__ method to iterate through its replication_cycles field.

If there are more pages, the __iter__ method will make additional ListReplicationCycles requests and continue to iterate through the replication_cycles field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListReplicationCyclesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListReplicationCyclesRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListReplicationCyclesResponse) – The initial response object.
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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListSourcesAsyncPager(method: Callable[[...], Awaitable[google.cloud.vmmigration_v1.types.vmmigration.ListSourcesResponse]], request: google.cloud.vmmigration_v1.types.vmmigration.ListSourcesRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListSourcesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_sources requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListSourcesResponse object, and provides an __aiter__ method to iterate through its sources field.

If there are more pages, the __aiter__ method will make additional ListSources requests and continue to iterate through the sources field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListSourcesRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListSourcesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListSourcesPager(method: Callable[[...], google.cloud.vmmigration_v1.types.vmmigration.ListSourcesResponse], request: google.cloud.vmmigration_v1.types.vmmigration.ListSourcesRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListSourcesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_sources requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListSourcesResponse object, and provides an __iter__ method to iterate through its sources field.

If there are more pages, the __iter__ method will make additional ListSources requests and continue to iterate through the sources field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListSourcesRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListSourcesResponse) – The initial response object.
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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListTargetProjectsAsyncPager(method: Callable[[...], Awaitable[google.cloud.vmmigration_v1.types.vmmigration.ListTargetProjectsResponse]], request: google.cloud.vmmigration_v1.types.vmmigration.ListTargetProjectsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListTargetProjectsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_target_projects requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListTargetProjectsResponse object, and provides an __aiter__ method to iterate through its target_projects field.

If there are more pages, the __aiter__ method will make additional ListTargetProjects requests and continue to iterate through the target_projects field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListTargetProjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListTargetProjectsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListTargetProjectsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListTargetProjectsPager(method: Callable[[...], google.cloud.vmmigration_v1.types.vmmigration.ListTargetProjectsResponse], request: google.cloud.vmmigration_v1.types.vmmigration.ListTargetProjectsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListTargetProjectsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_target_projects requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListTargetProjectsResponse object, and provides an __iter__ method to iterate through its target_projects field.

If there are more pages, the __iter__ method will make additional ListTargetProjects requests and continue to iterate through the target_projects field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListTargetProjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListTargetProjectsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListTargetProjectsResponse) – The initial response object.
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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListUtilizationReportsAsyncPager(method: Callable[[...], Awaitable[google.cloud.vmmigration_v1.types.vmmigration.ListUtilizationReportsResponse]], request: google.cloud.vmmigration_v1.types.vmmigration.ListUtilizationReportsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListUtilizationReportsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_utilization_reports requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListUtilizationReportsResponse object, and provides an __aiter__ method to iterate through its utilization_reports field.

If there are more pages, the __aiter__ method will make additional ListUtilizationReports requests and continue to iterate through the utilization_reports field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListUtilizationReportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListUtilizationReportsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListUtilizationReportsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.vmmigration_v1.services.vm_migration.pagers.ListUtilizationReportsPager(method: Callable[[...], google.cloud.vmmigration_v1.types.vmmigration.ListUtilizationReportsResponse], request: google.cloud.vmmigration_v1.types.vmmigration.ListUtilizationReportsRequest, response: google.cloud.vmmigration_v1.types.vmmigration.ListUtilizationReportsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_utilization_reports requests.

This class thinly wraps an initial google.cloud.vmmigration_v1.types.ListUtilizationReportsResponse object, and provides an __iter__ method to iterate through its utilization_reports field.

If there are more pages, the __iter__ method will make additional ListUtilizationReports requests and continue to iterate through the utilization_reports field on the corresponding responses.

All the usual google.cloud.vmmigration_v1.types.ListUtilizationReportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.vmmigration_v1.types.ListUtilizationReportsRequest) – The initial request object.
response (google.cloud.vmmigration_v1.types.ListUtilizationReportsResponse) – The initial response object.
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.

VmMigration¶

google-cloud-vm-migration

Navigation

Related Topics