Class VmMigrationClient (1.2.0)

public class VmMigrationClient implements BackgroundResource

Service Description: VM Migration Service

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   SourceName name = SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]");
   Source response = vmMigrationClient.getSource(name);
 }
 

Note: close() needs to be called on the VmMigrationClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of VmMigrationSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 VmMigrationSettings vmMigrationSettings =
     VmMigrationSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VmMigrationClient vmMigrationClient = VmMigrationClient.create(vmMigrationSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 VmMigrationSettings vmMigrationSettings =
     VmMigrationSettings.newBuilder().setEndpoint(myEndpoint).build();
 VmMigrationClient vmMigrationClient = VmMigrationClient.create(vmMigrationSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 VmMigrationSettings vmMigrationSettings =
     VmMigrationSettings.newBuilder()
         .setTransportChannelProvider(
             VmMigrationSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 VmMigrationClient vmMigrationClient = VmMigrationClient.create(vmMigrationSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > VmMigrationClient

Implements

BackgroundResource

Static Methods

create()

public static final VmMigrationClient create()

Constructs an instance of VmMigrationClient with default settings.

Returns
TypeDescription
VmMigrationClient
Exceptions
TypeDescription
IOException

create(VmMigrationSettings settings)

public static final VmMigrationClient create(VmMigrationSettings settings)

Constructs an instance of VmMigrationClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsVmMigrationSettings
Returns
TypeDescription
VmMigrationClient
Exceptions
TypeDescription
IOException

create(VmMigrationStub stub)

public static final VmMigrationClient create(VmMigrationStub stub)

Constructs an instance of VmMigrationClient, using the given stub for making calls. This is for advanced usage - prefer using create(VmMigrationSettings).

Parameter
NameDescription
stubVmMigrationStub
Returns
TypeDescription
VmMigrationClient

Constructors

VmMigrationClient(VmMigrationSettings settings)

protected VmMigrationClient(VmMigrationSettings settings)

Constructs an instance of VmMigrationClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
NameDescription
settingsVmMigrationSettings

VmMigrationClient(VmMigrationStub stub)

protected VmMigrationClient(VmMigrationStub stub)
Parameter
NameDescription
stubVmMigrationStub

Methods

addGroupMigrationAsync(AddGroupMigrationRequest request)

public final OperationFuture<AddGroupMigrationResponse,OperationMetadata> addGroupMigrationAsync(AddGroupMigrationRequest request)

Adds a MigratingVm to a Group.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   AddGroupMigrationRequest request =
       AddGroupMigrationRequest.newBuilder()
           .setGroup(GroupName.of("[PROJECT]", "[LOCATION]", "[GROUP]").toString())
           .setMigratingVm(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .build();
   AddGroupMigrationResponse response = vmMigrationClient.addGroupMigrationAsync(request).get();
 }
 
Parameter
NameDescription
requestAddGroupMigrationRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AddGroupMigrationResponse,OperationMetadata>

addGroupMigrationAsync(GroupName group)

public final OperationFuture<AddGroupMigrationResponse,OperationMetadata> addGroupMigrationAsync(GroupName group)

Adds a MigratingVm to a Group.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   GroupName group = GroupName.of("[PROJECT]", "[LOCATION]", "[GROUP]");
   AddGroupMigrationResponse response = vmMigrationClient.addGroupMigrationAsync(group).get();
 }
 
Parameter
NameDescription
groupGroupName

Required. The full path name of the Group to add to.

Returns
TypeDescription
OperationFuture<AddGroupMigrationResponse,OperationMetadata>

addGroupMigrationAsync(String group)

public final OperationFuture<AddGroupMigrationResponse,OperationMetadata> addGroupMigrationAsync(String group)

Adds a MigratingVm to a Group.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String group = GroupName.of("[PROJECT]", "[LOCATION]", "[GROUP]").toString();
   AddGroupMigrationResponse response = vmMigrationClient.addGroupMigrationAsync(group).get();
 }
 
Parameter
NameDescription
groupString

Required. The full path name of the Group to add to.

Returns
TypeDescription
OperationFuture<AddGroupMigrationResponse,OperationMetadata>

addGroupMigrationCallable()

public final UnaryCallable<AddGroupMigrationRequest,Operation> addGroupMigrationCallable()

Adds a MigratingVm to a Group.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   AddGroupMigrationRequest request =
       AddGroupMigrationRequest.newBuilder()
           .setGroup(GroupName.of("[PROJECT]", "[LOCATION]", "[GROUP]").toString())
           .setMigratingVm(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.addGroupMigrationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<AddGroupMigrationRequest,Operation>

addGroupMigrationOperationCallable()

public final OperationCallable<AddGroupMigrationRequest,AddGroupMigrationResponse,OperationMetadata> addGroupMigrationOperationCallable()

Adds a MigratingVm to a Group.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   AddGroupMigrationRequest request =
       AddGroupMigrationRequest.newBuilder()
           .setGroup(GroupName.of("[PROJECT]", "[LOCATION]", "[GROUP]").toString())
           .setMigratingVm(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .build();
   OperationFuture<AddGroupMigrationResponse, OperationMetadata> future =
       vmMigrationClient.addGroupMigrationOperationCallable().futureCall(request);
   // Do something.
   AddGroupMigrationResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<AddGroupMigrationRequest,AddGroupMigrationResponse,OperationMetadata>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

cancelCloneJobAsync(CancelCloneJobRequest request)

public final OperationFuture<CancelCloneJobResponse,OperationMetadata> cancelCloneJobAsync(CancelCloneJobRequest request)

Initiates the cancellation of a running clone job.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CancelCloneJobRequest request =
       CancelCloneJobRequest.newBuilder()
           .setName(
               CloneJobName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]", "[CLONE_JOB]")
                   .toString())
           .build();
   CancelCloneJobResponse response = vmMigrationClient.cancelCloneJobAsync(request).get();
 }
 
Parameter
NameDescription
requestCancelCloneJobRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<CancelCloneJobResponse,OperationMetadata>

cancelCloneJobAsync(CloneJobName name)

public final OperationFuture<CancelCloneJobResponse,OperationMetadata> cancelCloneJobAsync(CloneJobName name)

Initiates the cancellation of a running clone job.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CloneJobName name =
       CloneJobName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]", "[CLONE_JOB]");
   CancelCloneJobResponse response = vmMigrationClient.cancelCloneJobAsync(name).get();
 }
 
Parameter
NameDescription
nameCloneJobName

Required. The clone job id

Returns
TypeDescription
OperationFuture<CancelCloneJobResponse,OperationMetadata>

cancelCloneJobAsync(String name)

public final OperationFuture<CancelCloneJobResponse,OperationMetadata> cancelCloneJobAsync(String name)

Initiates the cancellation of a running clone job.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String name =
       CloneJobName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]", "[CLONE_JOB]")
           .toString();
   CancelCloneJobResponse response = vmMigrationClient.cancelCloneJobAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The clone job id

Returns
TypeDescription
OperationFuture<CancelCloneJobResponse,OperationMetadata>

cancelCloneJobCallable()

public final UnaryCallable<CancelCloneJobRequest,Operation> cancelCloneJobCallable()

Initiates the cancellation of a running clone job.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CancelCloneJobRequest request =
       CancelCloneJobRequest.newBuilder()
           .setName(
               CloneJobName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]", "[CLONE_JOB]")
                   .toString())
           .build();
   ApiFuture<Operation> future = vmMigrationClient.cancelCloneJobCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CancelCloneJobRequest,Operation>

cancelCloneJobOperationCallable()

public final OperationCallable<CancelCloneJobRequest,CancelCloneJobResponse,OperationMetadata> cancelCloneJobOperationCallable()

Initiates the cancellation of a running clone job.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CancelCloneJobRequest request =
       CancelCloneJobRequest.newBuilder()
           .setName(
               CloneJobName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]", "[CLONE_JOB]")
                   .toString())
           .build();
   OperationFuture<CancelCloneJobResponse, OperationMetadata> future =
       vmMigrationClient.cancelCloneJobOperationCallable().futureCall(request);
   // Do something.
   CancelCloneJobResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CancelCloneJobRequest,CancelCloneJobResponse,OperationMetadata>

cancelCutoverJobAsync(CancelCutoverJobRequest request)

public final OperationFuture<CancelCutoverJobResponse,OperationMetadata> cancelCutoverJobAsync(CancelCutoverJobRequest request)

Initiates the cancellation of a running cutover job.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CancelCutoverJobRequest request =
       CancelCutoverJobRequest.newBuilder()
           .setName(
               CutoverJobName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]", "[CUTOVER_JOB]")
                   .toString())
           .build();
   CancelCutoverJobResponse response = vmMigrationClient.cancelCutoverJobAsync(request).get();
 }
 
Parameter
NameDescription
requestCancelCutoverJobRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<CancelCutoverJobResponse,OperationMetadata>

cancelCutoverJobAsync(CutoverJobName name)

public final OperationFuture<CancelCutoverJobResponse,OperationMetadata> cancelCutoverJobAsync(CutoverJobName name)

Initiates the cancellation of a running cutover job.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CutoverJobName name =
       CutoverJobName.of(
           "[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]", "[CUTOVER_JOB]");
   CancelCutoverJobResponse response = vmMigrationClient.cancelCutoverJobAsync(name).get();
 }
 
Parameter
NameDescription
nameCutoverJobName

Required. The cutover job id

Returns
TypeDescription
OperationFuture<CancelCutoverJobResponse,OperationMetadata>

cancelCutoverJobAsync(String name)

public final OperationFuture<CancelCutoverJobResponse,OperationMetadata> cancelCutoverJobAsync(String name)

Initiates the cancellation of a running cutover job.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String name =
       CutoverJobName.of(
               "[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]", "[CUTOVER_JOB]")
           .toString();
   CancelCutoverJobResponse response = vmMigrationClient.cancelCutoverJobAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The cutover job id

Returns
TypeDescription
OperationFuture<CancelCutoverJobResponse,OperationMetadata>

cancelCutoverJobCallable()

public final UnaryCallable<CancelCutoverJobRequest,Operation> cancelCutoverJobCallable()

Initiates the cancellation of a running cutover job.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CancelCutoverJobRequest request =
       CancelCutoverJobRequest.newBuilder()
           .setName(
               CutoverJobName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]", "[CUTOVER_JOB]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.cancelCutoverJobCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CancelCutoverJobRequest,Operation>

cancelCutoverJobOperationCallable()

public final OperationCallable<CancelCutoverJobRequest,CancelCutoverJobResponse,OperationMetadata> cancelCutoverJobOperationCallable()

Initiates the cancellation of a running cutover job.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CancelCutoverJobRequest request =
       CancelCutoverJobRequest.newBuilder()
           .setName(
               CutoverJobName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]", "[CUTOVER_JOB]")
                   .toString())
           .build();
   OperationFuture<CancelCutoverJobResponse, OperationMetadata> future =
       vmMigrationClient.cancelCutoverJobOperationCallable().futureCall(request);
   // Do something.
   CancelCutoverJobResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CancelCutoverJobRequest,CancelCutoverJobResponse,OperationMetadata>

close()

public final void close()

createCloneJobAsync(CreateCloneJobRequest request)

public final OperationFuture<CloneJob,OperationMetadata> createCloneJobAsync(CreateCloneJobRequest request)

Initiates a Clone of a specific migrating VM.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateCloneJobRequest request =
       CreateCloneJobRequest.newBuilder()
           .setParent(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .setCloneJobId("cloneJobId2071309915")
           .setCloneJob(CloneJob.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   CloneJob response = vmMigrationClient.createCloneJobAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateCloneJobRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<CloneJob,OperationMetadata>

createCloneJobAsync(MigratingVmName parent, CloneJob cloneJob, String cloneJobId)

public final OperationFuture<CloneJob,OperationMetadata> createCloneJobAsync(MigratingVmName parent, CloneJob cloneJob, String cloneJobId)

Initiates a Clone of a specific migrating VM.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   MigratingVmName parent =
       MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]");
   CloneJob cloneJob = CloneJob.newBuilder().build();
   String cloneJobId = "cloneJobId2071309915";
   CloneJob response = vmMigrationClient.createCloneJobAsync(parent, cloneJob, cloneJobId).get();
 }
 
Parameters
NameDescription
parentMigratingVmName

Required. The Clone's parent.

cloneJobCloneJob

Required. The clone request body.

cloneJobIdString

Required. The clone job identifier.

Returns
TypeDescription
OperationFuture<CloneJob,OperationMetadata>

createCloneJobAsync(String parent, CloneJob cloneJob, String cloneJobId)

public final OperationFuture<CloneJob,OperationMetadata> createCloneJobAsync(String parent, CloneJob cloneJob, String cloneJobId)

Initiates a Clone of a specific migrating VM.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String parent =
       MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]").toString();
   CloneJob cloneJob = CloneJob.newBuilder().build();
   String cloneJobId = "cloneJobId2071309915";
   CloneJob response = vmMigrationClient.createCloneJobAsync(parent, cloneJob, cloneJobId).get();
 }
 
Parameters
NameDescription
parentString

Required. The Clone's parent.

cloneJobCloneJob

Required. The clone request body.

cloneJobIdString

Required. The clone job identifier.

Returns
TypeDescription
OperationFuture<CloneJob,OperationMetadata>

createCloneJobCallable()

public final UnaryCallable<CreateCloneJobRequest,Operation> createCloneJobCallable()

Initiates a Clone of a specific migrating VM.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateCloneJobRequest request =
       CreateCloneJobRequest.newBuilder()
           .setParent(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .setCloneJobId("cloneJobId2071309915")
           .setCloneJob(CloneJob.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = vmMigrationClient.createCloneJobCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateCloneJobRequest,Operation>

createCloneJobOperationCallable()

public final OperationCallable<CreateCloneJobRequest,CloneJob,OperationMetadata> createCloneJobOperationCallable()

Initiates a Clone of a specific migrating VM.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateCloneJobRequest request =
       CreateCloneJobRequest.newBuilder()
           .setParent(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .setCloneJobId("cloneJobId2071309915")
           .setCloneJob(CloneJob.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<CloneJob, OperationMetadata> future =
       vmMigrationClient.createCloneJobOperationCallable().futureCall(request);
   // Do something.
   CloneJob response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateCloneJobRequest,CloneJob,OperationMetadata>

createCutoverJobAsync(CreateCutoverJobRequest request)

public final OperationFuture<CutoverJob,OperationMetadata> createCutoverJobAsync(CreateCutoverJobRequest request)

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateCutoverJobRequest request =
       CreateCutoverJobRequest.newBuilder()
           .setParent(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .setCutoverJobId("cutoverJobId-2003089086")
           .setCutoverJob(CutoverJob.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   CutoverJob response = vmMigrationClient.createCutoverJobAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateCutoverJobRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<CutoverJob,OperationMetadata>

createCutoverJobAsync(MigratingVmName parent, CutoverJob cutoverJob, String cutoverJobId)

public final OperationFuture<CutoverJob,OperationMetadata> createCutoverJobAsync(MigratingVmName parent, CutoverJob cutoverJob, String cutoverJobId)

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   MigratingVmName parent =
       MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]");
   CutoverJob cutoverJob = CutoverJob.newBuilder().build();
   String cutoverJobId = "cutoverJobId-2003089086";
   CutoverJob response =
       vmMigrationClient.createCutoverJobAsync(parent, cutoverJob, cutoverJobId).get();
 }
 
Parameters
NameDescription
parentMigratingVmName

Required. The Cutover's parent.

cutoverJobCutoverJob

Required. The cutover request body.

cutoverJobIdString

Required. The cutover job identifier.

Returns
TypeDescription
OperationFuture<CutoverJob,OperationMetadata>

createCutoverJobAsync(String parent, CutoverJob cutoverJob, String cutoverJobId)

public final OperationFuture<CutoverJob,OperationMetadata> createCutoverJobAsync(String parent, CutoverJob cutoverJob, String cutoverJobId)

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String parent =
       MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]").toString();
   CutoverJob cutoverJob = CutoverJob.newBuilder().build();
   String cutoverJobId = "cutoverJobId-2003089086";
   CutoverJob response =
       vmMigrationClient.createCutoverJobAsync(parent, cutoverJob, cutoverJobId).get();
 }
 
Parameters
NameDescription
parentString

Required. The Cutover's parent.

cutoverJobCutoverJob

Required. The cutover request body.

cutoverJobIdString

Required. The cutover job identifier.

Returns
TypeDescription
OperationFuture<CutoverJob,OperationMetadata>

createCutoverJobCallable()

public final UnaryCallable<CreateCutoverJobRequest,Operation> createCutoverJobCallable()

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateCutoverJobRequest request =
       CreateCutoverJobRequest.newBuilder()
           .setParent(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .setCutoverJobId("cutoverJobId-2003089086")
           .setCutoverJob(CutoverJob.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.createCutoverJobCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateCutoverJobRequest,Operation>

createCutoverJobOperationCallable()

public final OperationCallable<CreateCutoverJobRequest,CutoverJob,OperationMetadata> createCutoverJobOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateCutoverJobRequest request =
       CreateCutoverJobRequest.newBuilder()
           .setParent(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .setCutoverJobId("cutoverJobId-2003089086")
           .setCutoverJob(CutoverJob.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<CutoverJob, OperationMetadata> future =
       vmMigrationClient.createCutoverJobOperationCallable().futureCall(request);
   // Do something.
   CutoverJob response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateCutoverJobRequest,CutoverJob,OperationMetadata>

createDatacenterConnectorAsync(CreateDatacenterConnectorRequest request)

public final OperationFuture<DatacenterConnector,OperationMetadata> createDatacenterConnectorAsync(CreateDatacenterConnectorRequest request)

Creates a new DatacenterConnector in a given Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateDatacenterConnectorRequest request =
       CreateDatacenterConnectorRequest.newBuilder()
           .setParent(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setDatacenterConnectorId("datacenterConnectorId-761889719")
           .setDatacenterConnector(DatacenterConnector.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   DatacenterConnector response =
       vmMigrationClient.createDatacenterConnectorAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateDatacenterConnectorRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<DatacenterConnector,OperationMetadata>

createDatacenterConnectorAsync(SourceName parent, DatacenterConnector datacenterConnector, String datacenterConnectorId)

public final OperationFuture<DatacenterConnector,OperationMetadata> createDatacenterConnectorAsync(SourceName parent, DatacenterConnector datacenterConnector, String datacenterConnectorId)

Creates a new DatacenterConnector in a given Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   SourceName parent = SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]");
   DatacenterConnector datacenterConnector = DatacenterConnector.newBuilder().build();
   String datacenterConnectorId = "datacenterConnectorId-761889719";
   DatacenterConnector response =
       vmMigrationClient
           .createDatacenterConnectorAsync(parent, datacenterConnector, datacenterConnectorId)
           .get();
 }
 
Parameters
NameDescription
parentSourceName

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

datacenterConnectorDatacenterConnector

Required. The create request body.

datacenterConnectorIdString

Required. The datacenterConnector identifier.

Returns
TypeDescription
OperationFuture<DatacenterConnector,OperationMetadata>

createDatacenterConnectorAsync(String parent, DatacenterConnector datacenterConnector, String datacenterConnectorId)

public final OperationFuture<DatacenterConnector,OperationMetadata> createDatacenterConnectorAsync(String parent, DatacenterConnector datacenterConnector, String datacenterConnectorId)

Creates a new DatacenterConnector in a given Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String parent = SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString();
   DatacenterConnector datacenterConnector = DatacenterConnector.newBuilder().build();
   String datacenterConnectorId = "datacenterConnectorId-761889719";
   DatacenterConnector response =
       vmMigrationClient
           .createDatacenterConnectorAsync(parent, datacenterConnector, datacenterConnectorId)
           .get();
 }
 
Parameters
NameDescription
parentString

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

datacenterConnectorDatacenterConnector

Required. The create request body.

datacenterConnectorIdString

Required. The datacenterConnector identifier.

Returns
TypeDescription
OperationFuture<DatacenterConnector,OperationMetadata>

createDatacenterConnectorCallable()

public final UnaryCallable<CreateDatacenterConnectorRequest,Operation> createDatacenterConnectorCallable()

Creates a new DatacenterConnector in a given Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateDatacenterConnectorRequest request =
       CreateDatacenterConnectorRequest.newBuilder()
           .setParent(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setDatacenterConnectorId("datacenterConnectorId-761889719")
           .setDatacenterConnector(DatacenterConnector.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.createDatacenterConnectorCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateDatacenterConnectorRequest,Operation>

createDatacenterConnectorOperationCallable()

public final OperationCallable<CreateDatacenterConnectorRequest,DatacenterConnector,OperationMetadata> createDatacenterConnectorOperationCallable()

Creates a new DatacenterConnector in a given Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateDatacenterConnectorRequest request =
       CreateDatacenterConnectorRequest.newBuilder()
           .setParent(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setDatacenterConnectorId("datacenterConnectorId-761889719")
           .setDatacenterConnector(DatacenterConnector.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<DatacenterConnector, OperationMetadata> future =
       vmMigrationClient.createDatacenterConnectorOperationCallable().futureCall(request);
   // Do something.
   DatacenterConnector response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateDatacenterConnectorRequest,DatacenterConnector,OperationMetadata>

createGroupAsync(CreateGroupRequest request)

public final OperationFuture<Group,OperationMetadata> createGroupAsync(CreateGroupRequest request)

Creates a new Group in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateGroupRequest request =
       CreateGroupRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setGroupId("groupId293428218")
           .setGroup(Group.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Group response = vmMigrationClient.createGroupAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateGroupRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Group,OperationMetadata>

createGroupAsync(LocationName parent, Group group, String groupId)

public final OperationFuture<Group,OperationMetadata> createGroupAsync(LocationName parent, Group group, String groupId)

Creates a new Group in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Group group = Group.newBuilder().build();
   String groupId = "groupId293428218";
   Group response = vmMigrationClient.createGroupAsync(parent, group, groupId).get();
 }
 
Parameters
NameDescription
parentLocationName

Required. The Group's parent.

groupGroup

Required. The create request body.

groupIdString

Required. The group identifier.

Returns
TypeDescription
OperationFuture<Group,OperationMetadata>

createGroupAsync(String parent, Group group, String groupId)

public final OperationFuture<Group,OperationMetadata> createGroupAsync(String parent, Group group, String groupId)

Creates a new Group in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Group group = Group.newBuilder().build();
   String groupId = "groupId293428218";
   Group response = vmMigrationClient.createGroupAsync(parent, group, groupId).get();
 }
 
Parameters
NameDescription
parentString

Required. The Group's parent.

groupGroup

Required. The create request body.

groupIdString

Required. The group identifier.

Returns
TypeDescription
OperationFuture<Group,OperationMetadata>

createGroupCallable()

public final UnaryCallable<CreateGroupRequest,Operation> createGroupCallable()

Creates a new Group in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateGroupRequest request =
       CreateGroupRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setGroupId("groupId293428218")
           .setGroup(Group.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = vmMigrationClient.createGroupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateGroupRequest,Operation>

createGroupOperationCallable()

public final OperationCallable<CreateGroupRequest,Group,OperationMetadata> createGroupOperationCallable()

Creates a new Group in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateGroupRequest request =
       CreateGroupRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setGroupId("groupId293428218")
           .setGroup(Group.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Group, OperationMetadata> future =
       vmMigrationClient.createGroupOperationCallable().futureCall(request);
   // Do something.
   Group response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateGroupRequest,Group,OperationMetadata>

createMigratingVmAsync(CreateMigratingVmRequest request)

public final OperationFuture<MigratingVm,OperationMetadata> createMigratingVmAsync(CreateMigratingVmRequest request)

Creates a new MigratingVm in a given Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateMigratingVmRequest request =
       CreateMigratingVmRequest.newBuilder()
           .setParent(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setMigratingVmId("migratingVmId441244154")
           .setMigratingVm(MigratingVm.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   MigratingVm response = vmMigrationClient.createMigratingVmAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateMigratingVmRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<MigratingVm,OperationMetadata>

createMigratingVmAsync(SourceName parent, MigratingVm migratingVm, String migratingVmId)

public final OperationFuture<MigratingVm,OperationMetadata> createMigratingVmAsync(SourceName parent, MigratingVm migratingVm, String migratingVmId)

Creates a new MigratingVm in a given Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   SourceName parent = SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]");
   MigratingVm migratingVm = MigratingVm.newBuilder().build();
   String migratingVmId = "migratingVmId441244154";
   MigratingVm response =
       vmMigrationClient.createMigratingVmAsync(parent, migratingVm, migratingVmId).get();
 }
 
Parameters
NameDescription
parentSourceName

Required. The MigratingVm's parent.

migratingVmMigratingVm

Required. The create request body.

migratingVmIdString

Required. The migratingVm identifier.

Returns
TypeDescription
OperationFuture<MigratingVm,OperationMetadata>

createMigratingVmAsync(String parent, MigratingVm migratingVm, String migratingVmId)

public final OperationFuture<MigratingVm,OperationMetadata> createMigratingVmAsync(String parent, MigratingVm migratingVm, String migratingVmId)

Creates a new MigratingVm in a given Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String parent = SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString();
   MigratingVm migratingVm = MigratingVm.newBuilder().build();
   String migratingVmId = "migratingVmId441244154";
   MigratingVm response =
       vmMigrationClient.createMigratingVmAsync(parent, migratingVm, migratingVmId).get();
 }
 
Parameters
NameDescription
parentString

Required. The MigratingVm's parent.

migratingVmMigratingVm

Required. The create request body.

migratingVmIdString

Required. The migratingVm identifier.

Returns
TypeDescription
OperationFuture<MigratingVm,OperationMetadata>

createMigratingVmCallable()

public final UnaryCallable<CreateMigratingVmRequest,Operation> createMigratingVmCallable()

Creates a new MigratingVm in a given Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateMigratingVmRequest request =
       CreateMigratingVmRequest.newBuilder()
           .setParent(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setMigratingVmId("migratingVmId441244154")
           .setMigratingVm(MigratingVm.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.createMigratingVmCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateMigratingVmRequest,Operation>

createMigratingVmOperationCallable()

public final OperationCallable<CreateMigratingVmRequest,MigratingVm,OperationMetadata> createMigratingVmOperationCallable()

Creates a new MigratingVm in a given Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateMigratingVmRequest request =
       CreateMigratingVmRequest.newBuilder()
           .setParent(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setMigratingVmId("migratingVmId441244154")
           .setMigratingVm(MigratingVm.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<MigratingVm, OperationMetadata> future =
       vmMigrationClient.createMigratingVmOperationCallable().futureCall(request);
   // Do something.
   MigratingVm response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateMigratingVmRequest,MigratingVm,OperationMetadata>

createSourceAsync(CreateSourceRequest request)

public final OperationFuture<Source,OperationMetadata> createSourceAsync(CreateSourceRequest request)

Creates a new Source in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateSourceRequest request =
       CreateSourceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSourceId("sourceId1746327190")
           .setSource(Source.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Source response = vmMigrationClient.createSourceAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateSourceRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Source,OperationMetadata>

createSourceAsync(LocationName parent, Source source, String sourceId)

public final OperationFuture<Source,OperationMetadata> createSourceAsync(LocationName parent, Source source, String sourceId)

Creates a new Source in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Source source = Source.newBuilder().build();
   String sourceId = "sourceId1746327190";
   Source response = vmMigrationClient.createSourceAsync(parent, source, sourceId).get();
 }
 
Parameters
NameDescription
parentLocationName

Required. The Source's parent.

sourceSource

Required. The create request body.

sourceIdString

Required. The source identifier.

Returns
TypeDescription
OperationFuture<Source,OperationMetadata>

createSourceAsync(String parent, Source source, String sourceId)

public final OperationFuture<Source,OperationMetadata> createSourceAsync(String parent, Source source, String sourceId)

Creates a new Source in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Source source = Source.newBuilder().build();
   String sourceId = "sourceId1746327190";
   Source response = vmMigrationClient.createSourceAsync(parent, source, sourceId).get();
 }
 
Parameters
NameDescription
parentString

Required. The Source's parent.

sourceSource

Required. The create request body.

sourceIdString

Required. The source identifier.

Returns
TypeDescription
OperationFuture<Source,OperationMetadata>

createSourceCallable()

public final UnaryCallable<CreateSourceRequest,Operation> createSourceCallable()

Creates a new Source in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateSourceRequest request =
       CreateSourceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSourceId("sourceId1746327190")
           .setSource(Source.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = vmMigrationClient.createSourceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateSourceRequest,Operation>

createSourceOperationCallable()

public final OperationCallable<CreateSourceRequest,Source,OperationMetadata> createSourceOperationCallable()

Creates a new Source in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateSourceRequest request =
       CreateSourceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSourceId("sourceId1746327190")
           .setSource(Source.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Source, OperationMetadata> future =
       vmMigrationClient.createSourceOperationCallable().futureCall(request);
   // Do something.
   Source response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateSourceRequest,Source,OperationMetadata>

createTargetProjectAsync(CreateTargetProjectRequest request)

public final OperationFuture<TargetProject,OperationMetadata> createTargetProjectAsync(CreateTargetProjectRequest request)

Creates a new TargetProject in a given project.

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateTargetProjectRequest request =
       CreateTargetProjectRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTargetProjectId("targetProjectId1290130307")
           .setTargetProject(TargetProject.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   TargetProject response = vmMigrationClient.createTargetProjectAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateTargetProjectRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<TargetProject,OperationMetadata>

createTargetProjectAsync(LocationName parent, TargetProject targetProject, String targetProjectId)

public final OperationFuture<TargetProject,OperationMetadata> createTargetProjectAsync(LocationName parent, TargetProject targetProject, String targetProjectId)

Creates a new TargetProject in a given project.

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   TargetProject targetProject = TargetProject.newBuilder().build();
   String targetProjectId = "targetProjectId1290130307";
   TargetProject response =
       vmMigrationClient.createTargetProjectAsync(parent, targetProject, targetProjectId).get();
 }
 
Parameters
NameDescription
parentLocationName

Required. The TargetProject's parent.

targetProjectTargetProject

Required. The create request body.

targetProjectIdString

Required. The target_project identifier.

Returns
TypeDescription
OperationFuture<TargetProject,OperationMetadata>

createTargetProjectAsync(String parent, TargetProject targetProject, String targetProjectId)

public final OperationFuture<TargetProject,OperationMetadata> createTargetProjectAsync(String parent, TargetProject targetProject, String targetProjectId)

Creates a new TargetProject in a given project.

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   TargetProject targetProject = TargetProject.newBuilder().build();
   String targetProjectId = "targetProjectId1290130307";
   TargetProject response =
       vmMigrationClient.createTargetProjectAsync(parent, targetProject, targetProjectId).get();
 }
 
Parameters
NameDescription
parentString

Required. The TargetProject's parent.

targetProjectTargetProject

Required. The create request body.

targetProjectIdString

Required. The target_project identifier.

Returns
TypeDescription
OperationFuture<TargetProject,OperationMetadata>

createTargetProjectCallable()

public final UnaryCallable<CreateTargetProjectRequest,Operation> createTargetProjectCallable()

Creates a new TargetProject in a given project.

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateTargetProjectRequest request =
       CreateTargetProjectRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTargetProjectId("targetProjectId1290130307")
           .setTargetProject(TargetProject.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.createTargetProjectCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateTargetProjectRequest,Operation>

createTargetProjectOperationCallable()

public final OperationCallable<CreateTargetProjectRequest,TargetProject,OperationMetadata> createTargetProjectOperationCallable()

Creates a new TargetProject in a given project.

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateTargetProjectRequest request =
       CreateTargetProjectRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTargetProjectId("targetProjectId1290130307")
           .setTargetProject(TargetProject.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<TargetProject, OperationMetadata> future =
       vmMigrationClient.createTargetProjectOperationCallable().futureCall(request);
   // Do something.
   TargetProject response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateTargetProjectRequest,TargetProject,OperationMetadata>

createUtilizationReportAsync(CreateUtilizationReportRequest request)

public final OperationFuture<UtilizationReport,OperationMetadata> createUtilizationReportAsync(CreateUtilizationReportRequest request)

Creates a new UtilizationReport.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateUtilizationReportRequest request =
       CreateUtilizationReportRequest.newBuilder()
           .setParent(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setUtilizationReport(UtilizationReport.newBuilder().build())
           .setUtilizationReportId("utilizationReportId1215771057")
           .setRequestId("requestId693933066")
           .build();
   UtilizationReport response = vmMigrationClient.createUtilizationReportAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateUtilizationReportRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<UtilizationReport,OperationMetadata>

createUtilizationReportAsync(SourceName parent, UtilizationReport utilizationReport, String utilizationReportId)

public final OperationFuture<UtilizationReport,OperationMetadata> createUtilizationReportAsync(SourceName parent, UtilizationReport utilizationReport, String utilizationReportId)

Creates a new UtilizationReport.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   SourceName parent = SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]");
   UtilizationReport utilizationReport = UtilizationReport.newBuilder().build();
   String utilizationReportId = "utilizationReportId1215771057";
   UtilizationReport response =
       vmMigrationClient
           .createUtilizationReportAsync(parent, utilizationReport, utilizationReportId)
           .get();
 }
 
Parameters
NameDescription
parentSourceName

Required. The Utilization Report's parent.

utilizationReportUtilizationReport

Required. The report to create.

utilizationReportIdString

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-/. It must start with an english letter and must not end with a hyphen.

Returns
TypeDescription
OperationFuture<UtilizationReport,OperationMetadata>

createUtilizationReportAsync(String parent, UtilizationReport utilizationReport, String utilizationReportId)

public final OperationFuture<UtilizationReport,OperationMetadata> createUtilizationReportAsync(String parent, UtilizationReport utilizationReport, String utilizationReportId)

Creates a new UtilizationReport.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String parent = SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString();
   UtilizationReport utilizationReport = UtilizationReport.newBuilder().build();
   String utilizationReportId = "utilizationReportId1215771057";
   UtilizationReport response =
       vmMigrationClient
           .createUtilizationReportAsync(parent, utilizationReport, utilizationReportId)
           .get();
 }
 
Parameters
NameDescription
parentString

Required. The Utilization Report's parent.

utilizationReportUtilizationReport

Required. The report to create.

utilizationReportIdString

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-/. It must start with an english letter and must not end with a hyphen.

Returns
TypeDescription
OperationFuture<UtilizationReport,OperationMetadata>

createUtilizationReportCallable()

public final UnaryCallable<CreateUtilizationReportRequest,Operation> createUtilizationReportCallable()

Creates a new UtilizationReport.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateUtilizationReportRequest request =
       CreateUtilizationReportRequest.newBuilder()
           .setParent(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setUtilizationReport(UtilizationReport.newBuilder().build())
           .setUtilizationReportId("utilizationReportId1215771057")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.createUtilizationReportCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateUtilizationReportRequest,Operation>

createUtilizationReportOperationCallable()

public final OperationCallable<CreateUtilizationReportRequest,UtilizationReport,OperationMetadata> createUtilizationReportOperationCallable()

Creates a new UtilizationReport.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   CreateUtilizationReportRequest request =
       CreateUtilizationReportRequest.newBuilder()
           .setParent(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setUtilizationReport(UtilizationReport.newBuilder().build())
           .setUtilizationReportId("utilizationReportId1215771057")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<UtilizationReport, OperationMetadata> future =
       vmMigrationClient.createUtilizationReportOperationCallable().futureCall(request);
   // Do something.
   UtilizationReport response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateUtilizationReportRequest,UtilizationReport,OperationMetadata>

deleteDatacenterConnectorAsync(DatacenterConnectorName name)

public final OperationFuture<Empty,OperationMetadata> deleteDatacenterConnectorAsync(DatacenterConnectorName name)

Deletes a single DatacenterConnector.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DatacenterConnectorName name =
       DatacenterConnectorName.of(
           "[PROJECT]", "[LOCATION]", "[SOURCE]", "[DATACENTER_CONNECTOR]");
   vmMigrationClient.deleteDatacenterConnectorAsync(name).get();
 }
 
Parameter
NameDescription
nameDatacenterConnectorName

Required. The DatacenterConnector name.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteDatacenterConnectorAsync(DeleteDatacenterConnectorRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteDatacenterConnectorAsync(DeleteDatacenterConnectorRequest request)

Deletes a single DatacenterConnector.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteDatacenterConnectorRequest request =
       DeleteDatacenterConnectorRequest.newBuilder()
           .setName(
               DatacenterConnectorName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[DATACENTER_CONNECTOR]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   vmMigrationClient.deleteDatacenterConnectorAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteDatacenterConnectorRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteDatacenterConnectorAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteDatacenterConnectorAsync(String name)

Deletes a single DatacenterConnector.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String name =
       DatacenterConnectorName.of(
               "[PROJECT]", "[LOCATION]", "[SOURCE]", "[DATACENTER_CONNECTOR]")
           .toString();
   vmMigrationClient.deleteDatacenterConnectorAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The DatacenterConnector name.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteDatacenterConnectorCallable()

public final UnaryCallable<DeleteDatacenterConnectorRequest,Operation> deleteDatacenterConnectorCallable()

Deletes a single DatacenterConnector.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteDatacenterConnectorRequest request =
       DeleteDatacenterConnectorRequest.newBuilder()
           .setName(
               DatacenterConnectorName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[DATACENTER_CONNECTOR]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.deleteDatacenterConnectorCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteDatacenterConnectorRequest,Operation>

deleteDatacenterConnectorOperationCallable()

public final OperationCallable<DeleteDatacenterConnectorRequest,Empty,OperationMetadata> deleteDatacenterConnectorOperationCallable()

Deletes a single DatacenterConnector.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteDatacenterConnectorRequest request =
       DeleteDatacenterConnectorRequest.newBuilder()
           .setName(
               DatacenterConnectorName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[DATACENTER_CONNECTOR]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmMigrationClient.deleteDatacenterConnectorOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteDatacenterConnectorRequest,Empty,OperationMetadata>

deleteGroupAsync(DeleteGroupRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteGroupAsync(DeleteGroupRequest request)

Deletes a single Group.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteGroupRequest request =
       DeleteGroupRequest.newBuilder()
           .setName(GroupName.of("[PROJECT]", "[LOCATION]", "[GROUP]").toString())
           .setRequestId("requestId693933066")
           .build();
   vmMigrationClient.deleteGroupAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteGroupRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteGroupAsync(GroupName name)

public final OperationFuture<Empty,OperationMetadata> deleteGroupAsync(GroupName name)

Deletes a single Group.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[LOCATION]", "[GROUP]");
   vmMigrationClient.deleteGroupAsync(name).get();
 }
 
Parameter
NameDescription
nameGroupName

Required. The Group name.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteGroupAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteGroupAsync(String name)

Deletes a single Group.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String name = GroupName.of("[PROJECT]", "[LOCATION]", "[GROUP]").toString();
   vmMigrationClient.deleteGroupAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The Group name.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteGroupCallable()

public final UnaryCallable<DeleteGroupRequest,Operation> deleteGroupCallable()

Deletes a single Group.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteGroupRequest request =
       DeleteGroupRequest.newBuilder()
           .setName(GroupName.of("[PROJECT]", "[LOCATION]", "[GROUP]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = vmMigrationClient.deleteGroupCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteGroupRequest,Operation>

deleteGroupOperationCallable()

public final OperationCallable<DeleteGroupRequest,Empty,OperationMetadata> deleteGroupOperationCallable()

Deletes a single Group.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteGroupRequest request =
       DeleteGroupRequest.newBuilder()
           .setName(GroupName.of("[PROJECT]", "[LOCATION]", "[GROUP]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmMigrationClient.deleteGroupOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteGroupRequest,Empty,OperationMetadata>

deleteMigratingVmAsync(DeleteMigratingVmRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteMigratingVmAsync(DeleteMigratingVmRequest request)

Deletes a single MigratingVm.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteMigratingVmRequest request =
       DeleteMigratingVmRequest.newBuilder()
           .setName(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .build();
   vmMigrationClient.deleteMigratingVmAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteMigratingVmRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteMigratingVmAsync(MigratingVmName name)

public final OperationFuture<Empty,OperationMetadata> deleteMigratingVmAsync(MigratingVmName name)

Deletes a single MigratingVm.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   MigratingVmName name =
       MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]");
   vmMigrationClient.deleteMigratingVmAsync(name).get();
 }
 
Parameter
NameDescription
nameMigratingVmName

Required. The name of the MigratingVm.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteMigratingVmAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteMigratingVmAsync(String name)

Deletes a single MigratingVm.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String name =
       MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]").toString();
   vmMigrationClient.deleteMigratingVmAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The name of the MigratingVm.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteMigratingVmCallable()

public final UnaryCallable<DeleteMigratingVmRequest,Operation> deleteMigratingVmCallable()

Deletes a single MigratingVm.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteMigratingVmRequest request =
       DeleteMigratingVmRequest.newBuilder()
           .setName(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.deleteMigratingVmCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteMigratingVmRequest,Operation>

deleteMigratingVmOperationCallable()

public final OperationCallable<DeleteMigratingVmRequest,Empty,OperationMetadata> deleteMigratingVmOperationCallable()

Deletes a single MigratingVm.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteMigratingVmRequest request =
       DeleteMigratingVmRequest.newBuilder()
           .setName(
               MigratingVmName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[MIGRATING_VM]")
                   .toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmMigrationClient.deleteMigratingVmOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteMigratingVmRequest,Empty,OperationMetadata>

deleteSourceAsync(DeleteSourceRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteSourceAsync(DeleteSourceRequest request)

Deletes a single Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteSourceRequest request =
       DeleteSourceRequest.newBuilder()
           .setName(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setRequestId("requestId693933066")
           .build();
   vmMigrationClient.deleteSourceAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteSourceRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteSourceAsync(SourceName name)

public final OperationFuture<Empty,OperationMetadata> deleteSourceAsync(SourceName name)

Deletes a single Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   SourceName name = SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]");
   vmMigrationClient.deleteSourceAsync(name).get();
 }
 
Parameter
NameDescription
nameSourceName

Required. The Source name.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteSourceAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteSourceAsync(String name)

Deletes a single Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String name = SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString();
   vmMigrationClient.deleteSourceAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The Source name.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteSourceCallable()

public final UnaryCallable<DeleteSourceRequest,Operation> deleteSourceCallable()

Deletes a single Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteSourceRequest request =
       DeleteSourceRequest.newBuilder()
           .setName(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = vmMigrationClient.deleteSourceCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteSourceRequest,Operation>

deleteSourceOperationCallable()

public final OperationCallable<DeleteSourceRequest,Empty,OperationMetadata> deleteSourceOperationCallable()

Deletes a single Source.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteSourceRequest request =
       DeleteSourceRequest.newBuilder()
           .setName(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmMigrationClient.deleteSourceOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteSourceRequest,Empty,OperationMetadata>

deleteTargetProjectAsync(DeleteTargetProjectRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteTargetProjectAsync(DeleteTargetProjectRequest request)

Deletes a single TargetProject.

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteTargetProjectRequest request =
       DeleteTargetProjectRequest.newBuilder()
           .setName(
               TargetProjectName.of("[PROJECT]", "[LOCATION]", "[TARGET_PROJECT]").toString())
           .setRequestId("requestId693933066")
           .build();
   vmMigrationClient.deleteTargetProjectAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteTargetProjectRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteTargetProjectAsync(TargetProjectName name)

public final OperationFuture<Empty,OperationMetadata> deleteTargetProjectAsync(TargetProjectName name)

Deletes a single TargetProject.

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   TargetProjectName name = TargetProjectName.of("[PROJECT]", "[LOCATION]", "[TARGET_PROJECT]");
   vmMigrationClient.deleteTargetProjectAsync(name).get();
 }
 
Parameter
NameDescription
nameTargetProjectName

Required. The TargetProject name.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteTargetProjectAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteTargetProjectAsync(String name)

Deletes a single TargetProject.

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String name = TargetProjectName.of("[PROJECT]", "[LOCATION]", "[TARGET_PROJECT]").toString();
   vmMigrationClient.deleteTargetProjectAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The TargetProject name.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteTargetProjectCallable()

public final UnaryCallable<DeleteTargetProjectRequest,Operation> deleteTargetProjectCallable()

Deletes a single TargetProject.

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteTargetProjectRequest request =
       DeleteTargetProjectRequest.newBuilder()
           .setName(
               TargetProjectName.of("[PROJECT]", "[LOCATION]", "[TARGET_PROJECT]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.deleteTargetProjectCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteTargetProjectRequest,Operation>

deleteTargetProjectOperationCallable()

public final OperationCallable<DeleteTargetProjectRequest,Empty,OperationMetadata> deleteTargetProjectOperationCallable()

Deletes a single TargetProject.

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteTargetProjectRequest request =
       DeleteTargetProjectRequest.newBuilder()
           .setName(
               TargetProjectName.of("[PROJECT]", "[LOCATION]", "[TARGET_PROJECT]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmMigrationClient.deleteTargetProjectOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteTargetProjectRequest,Empty,OperationMetadata>

deleteUtilizationReportAsync(DeleteUtilizationReportRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteUtilizationReportAsync(DeleteUtilizationReportRequest request)

Deletes a single Utilization Report.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteUtilizationReportRequest request =
       DeleteUtilizationReportRequest.newBuilder()
           .setName(
               UtilizationReportName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[UTILIZATION_REPORT]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   vmMigrationClient.deleteUtilizationReportAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteUtilizationReportRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteUtilizationReportAsync(UtilizationReportName name)

public final OperationFuture<Empty,OperationMetadata> deleteUtilizationReportAsync(UtilizationReportName name)

Deletes a single Utilization Report.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   UtilizationReportName name =
       UtilizationReportName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[UTILIZATION_REPORT]");
   vmMigrationClient.deleteUtilizationReportAsync(name).get();
 }
 
Parameter
NameDescription
nameUtilizationReportName

Required. The Utilization Report name.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteUtilizationReportAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteUtilizationReportAsync(String name)

Deletes a single Utilization Report.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   String name =
       UtilizationReportName.of("[PROJECT]", "[LOCATION]", "[SOURCE]", "[UTILIZATION_REPORT]")
           .toString();
   vmMigrationClient.deleteUtilizationReportAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The Utilization Report name.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteUtilizationReportCallable()

public final UnaryCallable<DeleteUtilizationReportRequest,Operation> deleteUtilizationReportCallable()

Deletes a single Utilization Report.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteUtilizationReportRequest request =
       DeleteUtilizationReportRequest.newBuilder()
           .setName(
               UtilizationReportName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[UTILIZATION_REPORT]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmMigrationClient.deleteUtilizationReportCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteUtilizationReportRequest,Operation>

deleteUtilizationReportOperationCallable()

public final OperationCallable<DeleteUtilizationReportRequest,Empty,OperationMetadata> deleteUtilizationReportOperationCallable()

Deletes a single Utilization Report.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   DeleteUtilizationReportRequest request =
       DeleteUtilizationReportRequest.newBuilder()
           .setName(
               UtilizationReportName.of(
                       "[PROJECT]", "[LOCATION]", "[SOURCE]", "[UTILIZATION_REPORT]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmMigrationClient.deleteUtilizationReportOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteUtilizationReportRequest,Empty,OperationMetadata>

fetchInventory(FetchInventoryRequest request)

public final FetchInventoryResponse fetchInventory(FetchInventoryRequest request)

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (VmMigrationClient vmMigrationClient = VmMigrationClient.create()) {
   FetchInventoryRequest request =
       FetchInventoryRequest.newBuilder()
           .setSource(SourceName.of("[PROJECT]", "[LOCATION]", "[SOURCE]").toString())
           .setForceRefresh(true)
           .build();
   Fet