Class MigrationServiceClient (0.17.0)

public class MigrationServiceClient implements BackgroundResource

Service Description: Service to handle EDW migrations.

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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   MigrationWorkflow migrationWorkflow = MigrationWorkflow.newBuilder().build();
   MigrationWorkflow response =
       migrationServiceClient.createMigrationWorkflow(parent, migrationWorkflow);
 }
 

Note: close() needs to be called on the MigrationServiceClient 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 MigrationServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 MigrationServiceSettings migrationServiceSettings =
     MigrationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MigrationServiceClient migrationServiceClient =
     MigrationServiceClient.create(migrationServiceSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 MigrationServiceSettings migrationServiceSettings =
     MigrationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 MigrationServiceClient migrationServiceClient =
     MigrationServiceClient.create(migrationServiceSettings);
 

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 MigrationServiceSettings migrationServiceSettings =
     MigrationServiceSettings.newHttpJsonBuilder().build();
 MigrationServiceClient migrationServiceClient =
     MigrationServiceClient.create(migrationServiceSettings);
 

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

Inheritance

java.lang.Object > MigrationServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final MigrationServiceClient create()

Constructs an instance of MigrationServiceClient with default settings.

Returns
TypeDescription
MigrationServiceClient
Exceptions
TypeDescription
IOException

create(MigrationServiceSettings settings)

public static final MigrationServiceClient create(MigrationServiceSettings settings)

Constructs an instance of MigrationServiceClient, 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
settingsMigrationServiceSettings
Returns
TypeDescription
MigrationServiceClient
Exceptions
TypeDescription
IOException

create(MigrationServiceStub stub)

public static final MigrationServiceClient create(MigrationServiceStub stub)

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

Parameter
NameDescription
stubMigrationServiceStub
Returns
TypeDescription
MigrationServiceClient

Constructors

MigrationServiceClient(MigrationServiceSettings settings)

protected MigrationServiceClient(MigrationServiceSettings settings)

Constructs an instance of MigrationServiceClient, 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
settingsMigrationServiceSettings

MigrationServiceClient(MigrationServiceStub stub)

protected MigrationServiceClient(MigrationServiceStub stub)
Parameter
NameDescription
stubMigrationServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

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

close()

public final void close()

createMigrationWorkflow(CreateMigrationWorkflowRequest request)

public final MigrationWorkflow createMigrationWorkflow(CreateMigrationWorkflowRequest request)

Creates a migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   CreateMigrationWorkflowRequest request =
       CreateMigrationWorkflowRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setMigrationWorkflow(MigrationWorkflow.newBuilder().build())
           .build();
   MigrationWorkflow response = migrationServiceClient.createMigrationWorkflow(request);
 }
 
Parameter
NameDescription
requestCreateMigrationWorkflowRequest

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

Returns
TypeDescription
MigrationWorkflow

createMigrationWorkflow(LocationName parent, MigrationWorkflow migrationWorkflow)

public final MigrationWorkflow createMigrationWorkflow(LocationName parent, MigrationWorkflow migrationWorkflow)

Creates a migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   MigrationWorkflow migrationWorkflow = MigrationWorkflow.newBuilder().build();
   MigrationWorkflow response =
       migrationServiceClient.createMigrationWorkflow(parent, migrationWorkflow);
 }
 
Parameters
NameDescription
parentLocationName

Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar

migrationWorkflowMigrationWorkflow

Required. The migration workflow to create.

Returns
TypeDescription
MigrationWorkflow

createMigrationWorkflow(String parent, MigrationWorkflow migrationWorkflow)

public final MigrationWorkflow createMigrationWorkflow(String parent, MigrationWorkflow migrationWorkflow)

Creates a migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   MigrationWorkflow migrationWorkflow = MigrationWorkflow.newBuilder().build();
   MigrationWorkflow response =
       migrationServiceClient.createMigrationWorkflow(parent, migrationWorkflow);
 }
 
Parameters
NameDescription
parentString

Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar

migrationWorkflowMigrationWorkflow

Required. The migration workflow to create.

Returns
TypeDescription
MigrationWorkflow

createMigrationWorkflowCallable()

public final UnaryCallable<CreateMigrationWorkflowRequest,MigrationWorkflow> createMigrationWorkflowCallable()

Creates a migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   CreateMigrationWorkflowRequest request =
       CreateMigrationWorkflowRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setMigrationWorkflow(MigrationWorkflow.newBuilder().build())
           .build();
   ApiFuture<MigrationWorkflow> future =
       migrationServiceClient.createMigrationWorkflowCallable().futureCall(request);
   // Do something.
   MigrationWorkflow response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateMigrationWorkflowRequest,MigrationWorkflow>

deleteMigrationWorkflow(DeleteMigrationWorkflowRequest request)

public final void deleteMigrationWorkflow(DeleteMigrationWorkflowRequest request)

Deletes a migration workflow by name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   DeleteMigrationWorkflowRequest request =
       DeleteMigrationWorkflowRequest.newBuilder()
           .setName(MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .build();
   migrationServiceClient.deleteMigrationWorkflow(request);
 }
 
Parameter
NameDescription
requestDeleteMigrationWorkflowRequest

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

deleteMigrationWorkflow(MigrationWorkflowName name)

public final void deleteMigrationWorkflow(MigrationWorkflowName name)

Deletes a migration workflow by name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   MigrationWorkflowName name =
       MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
   migrationServiceClient.deleteMigrationWorkflow(name);
 }
 
Parameter
NameDescription
nameMigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

deleteMigrationWorkflow(String name)

public final void deleteMigrationWorkflow(String name)

Deletes a migration workflow by name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   String name = MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString();
   migrationServiceClient.deleteMigrationWorkflow(name);
 }
 
Parameter
NameDescription
nameString

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

deleteMigrationWorkflowCallable()

public final UnaryCallable<DeleteMigrationWorkflowRequest,Empty> deleteMigrationWorkflowCallable()

Deletes a migration workflow by name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   DeleteMigrationWorkflowRequest request =
       DeleteMigrationWorkflowRequest.newBuilder()
           .setName(MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .build();
   ApiFuture<Empty> future =
       migrationServiceClient.deleteMigrationWorkflowCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteMigrationWorkflowRequest,Empty>

getMigrationSubtask(GetMigrationSubtaskRequest request)

public final MigrationSubtask getMigrationSubtask(GetMigrationSubtaskRequest request)

Gets a previously created migration subtask.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   GetMigrationSubtaskRequest request =
       GetMigrationSubtaskRequest.newBuilder()
           .setName(
               MigrationSubtaskName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[SUBTASK]")
                   .toString())
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   MigrationSubtask response = migrationServiceClient.getMigrationSubtask(request);
 }
 
Parameter
NameDescription
requestGetMigrationSubtaskRequest

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

Returns
TypeDescription
MigrationSubtask

getMigrationSubtask(MigrationSubtaskName name)

public final MigrationSubtask getMigrationSubtask(MigrationSubtaskName name)

Gets a previously created migration subtask.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   MigrationSubtaskName name =
       MigrationSubtaskName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[SUBTASK]");
   MigrationSubtask response = migrationServiceClient.getMigrationSubtask(name);
 }
 
Parameter
NameDescription
nameMigrationSubtaskName

Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543

Returns
TypeDescription
MigrationSubtask

getMigrationSubtask(String name)

public final MigrationSubtask getMigrationSubtask(String name)

Gets a previously created migration subtask.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   String name =
       MigrationSubtaskName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[SUBTASK]").toString();
   MigrationSubtask response = migrationServiceClient.getMigrationSubtask(name);
 }
 
Parameter
NameDescription
nameString

Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543

Returns
TypeDescription
MigrationSubtask

getMigrationSubtaskCallable()

public final UnaryCallable<GetMigrationSubtaskRequest,MigrationSubtask> getMigrationSubtaskCallable()

Gets a previously created migration subtask.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   GetMigrationSubtaskRequest request =
       GetMigrationSubtaskRequest.newBuilder()
           .setName(
               MigrationSubtaskName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[SUBTASK]")
                   .toString())
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<MigrationSubtask> future =
       migrationServiceClient.getMigrationSubtaskCallable().futureCall(request);
   // Do something.
   MigrationSubtask response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetMigrationSubtaskRequest,MigrationSubtask>

getMigrationWorkflow(GetMigrationWorkflowRequest request)

public final MigrationWorkflow getMigrationWorkflow(GetMigrationWorkflowRequest request)

Gets a previously created migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   GetMigrationWorkflowRequest request =
       GetMigrationWorkflowRequest.newBuilder()
           .setName(MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   MigrationWorkflow response = migrationServiceClient.getMigrationWorkflow(request);
 }
 
Parameter
NameDescription
requestGetMigrationWorkflowRequest

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

Returns
TypeDescription
MigrationWorkflow

getMigrationWorkflow(MigrationWorkflowName name)

public final MigrationWorkflow getMigrationWorkflow(MigrationWorkflowName name)

Gets a previously created migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   MigrationWorkflowName name =
       MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
   MigrationWorkflow response = migrationServiceClient.getMigrationWorkflow(name);
 }
 
Parameter
NameDescription
nameMigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

Returns
TypeDescription
MigrationWorkflow

getMigrationWorkflow(String name)

public final MigrationWorkflow getMigrationWorkflow(String name)

Gets a previously created migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   String name = MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString();
   MigrationWorkflow response = migrationServiceClient.getMigrationWorkflow(name);
 }
 
Parameter
NameDescription
nameString

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

Returns
TypeDescription
MigrationWorkflow

getMigrationWorkflowCallable()

public final UnaryCallable<GetMigrationWorkflowRequest,MigrationWorkflow> getMigrationWorkflowCallable()

Gets a previously created migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   GetMigrationWorkflowRequest request =
       GetMigrationWorkflowRequest.newBuilder()
           .setName(MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<MigrationWorkflow> future =
       migrationServiceClient.getMigrationWorkflowCallable().futureCall(request);
   // Do something.
   MigrationWorkflow response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetMigrationWorkflowRequest,MigrationWorkflow>

getSettings()

public final MigrationServiceSettings getSettings()
Returns
TypeDescription
MigrationServiceSettings

getStub()

public MigrationServiceStub getStub()
Returns
TypeDescription
MigrationServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listMigrationSubtasks(ListMigrationSubtasksRequest request)

public final MigrationServiceClient.ListMigrationSubtasksPagedResponse listMigrationSubtasks(ListMigrationSubtasksRequest request)

Lists previously created migration subtasks.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   ListMigrationSubtasksRequest request =
       ListMigrationSubtasksRequest.newBuilder()
           .setParent(
               MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setReadMask(FieldMask.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (MigrationSubtask element :
       migrationServiceClient.listMigrationSubtasks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListMigrationSubtasksRequest

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

Returns
TypeDescription
MigrationServiceClient.ListMigrationSubtasksPagedResponse

listMigrationSubtasks(MigrationWorkflowName parent)

public final MigrationServiceClient.ListMigrationSubtasksPagedResponse listMigrationSubtasks(MigrationWorkflowName parent)

Lists previously created migration subtasks.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   MigrationWorkflowName parent =
       MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
   for (MigrationSubtask element :
       migrationServiceClient.listMigrationSubtasks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentMigrationWorkflowName

Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234

Returns
TypeDescription
MigrationServiceClient.ListMigrationSubtasksPagedResponse

listMigrationSubtasks(String parent)

public final MigrationServiceClient.ListMigrationSubtasksPagedResponse listMigrationSubtasks(String parent)

Lists previously created migration subtasks.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   String parent = MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString();
   for (MigrationSubtask element :
       migrationServiceClient.listMigrationSubtasks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234

Returns
TypeDescription
MigrationServiceClient.ListMigrationSubtasksPagedResponse

listMigrationSubtasksCallable()

public final UnaryCallable<ListMigrationSubtasksRequest,ListMigrationSubtasksResponse> listMigrationSubtasksCallable()

Lists previously created migration subtasks.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   ListMigrationSubtasksRequest request =
       ListMigrationSubtasksRequest.newBuilder()
           .setParent(
               MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setReadMask(FieldMask.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListMigrationSubtasksResponse response =
         migrationServiceClient.listMigrationSubtasksCallable().call(request);
     for (MigrationSubtask element : response.getMigrationSubtasksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListMigrationSubtasksRequest,ListMigrationSubtasksResponse>

listMigrationSubtasksPagedCallable()

public final UnaryCallable<ListMigrationSubtasksRequest,MigrationServiceClient.ListMigrationSubtasksPagedResponse> listMigrationSubtasksPagedCallable()

Lists previously created migration subtasks.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   ListMigrationSubtasksRequest request =
       ListMigrationSubtasksRequest.newBuilder()
           .setParent(
               MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setReadMask(FieldMask.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<MigrationSubtask> future =
       migrationServiceClient.listMigrationSubtasksPagedCallable().futureCall(request);
   // Do something.
   for (MigrationSubtask element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListMigrationSubtasksRequest,ListMigrationSubtasksPagedResponse>

listMigrationWorkflows(ListMigrationWorkflowsRequest request)

public final MigrationServiceClient.ListMigrationWorkflowsPagedResponse listMigrationWorkflows(ListMigrationWorkflowsRequest request)

Lists previously created migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   ListMigrationWorkflowsRequest request =
       ListMigrationWorkflowsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setReadMask(FieldMask.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (MigrationWorkflow element :
       migrationServiceClient.listMigrationWorkflows(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListMigrationWorkflowsRequest

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

Returns
TypeDescription
MigrationServiceClient.ListMigrationWorkflowsPagedResponse

listMigrationWorkflows(LocationName parent)

public final MigrationServiceClient.ListMigrationWorkflowsPagedResponse listMigrationWorkflows(LocationName parent)

Lists previously created migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (MigrationWorkflow element :
       migrationServiceClient.listMigrationWorkflows(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The project and location of the migration workflows to list. Example: projects/123/locations/us

Returns
TypeDescription
MigrationServiceClient.ListMigrationWorkflowsPagedResponse

listMigrationWorkflows(String parent)

public final MigrationServiceClient.ListMigrationWorkflowsPagedResponse listMigrationWorkflows(String parent)

Lists previously created migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (MigrationWorkflow element :
       migrationServiceClient.listMigrationWorkflows(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The project and location of the migration workflows to list. Example: projects/123/locations/us

Returns
TypeDescription
MigrationServiceClient.ListMigrationWorkflowsPagedResponse

listMigrationWorkflowsCallable()

public final UnaryCallable<ListMigrationWorkflowsRequest,ListMigrationWorkflowsResponse> listMigrationWorkflowsCallable()

Lists previously created migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   ListMigrationWorkflowsRequest request =
       ListMigrationWorkflowsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setReadMask(FieldMask.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListMigrationWorkflowsResponse response =
         migrationServiceClient.listMigrationWorkflowsCallable().call(request);
     for (MigrationWorkflow element : response.getMigrationWorkflowsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListMigrationWorkflowsRequest,ListMigrationWorkflowsResponse>

listMigrationWorkflowsPagedCallable()

public final UnaryCallable<ListMigrationWorkflowsRequest,MigrationServiceClient.ListMigrationWorkflowsPagedResponse> listMigrationWorkflowsPagedCallable()

Lists previously created migration workflow.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   ListMigrationWorkflowsRequest request =
       ListMigrationWorkflowsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setReadMask(FieldMask.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<MigrationWorkflow> future =
       migrationServiceClient.listMigrationWorkflowsPagedCallable().futureCall(request);
   // Do something.
   for (MigrationWorkflow element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListMigrationWorkflowsRequest,ListMigrationWorkflowsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

startMigrationWorkflow(MigrationWorkflowName name)

public final void startMigrationWorkflow(MigrationWorkflowName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   MigrationWorkflowName name =
       MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
   migrationServiceClient.startMigrationWorkflow(name);
 }
 
Parameter
NameDescription
nameMigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

startMigrationWorkflow(StartMigrationWorkflowRequest request)

public final void startMigrationWorkflow(StartMigrationWorkflowRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   StartMigrationWorkflowRequest request =
       StartMigrationWorkflowRequest.newBuilder()
           .setName(MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .build();
   migrationServiceClient.startMigrationWorkflow(request);
 }
 
Parameter
NameDescription
requestStartMigrationWorkflowRequest

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

startMigrationWorkflow(String name)

public final void startMigrationWorkflow(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   String name = MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString();
   migrationServiceClient.startMigrationWorkflow(name);
 }
 
Parameter
NameDescription
nameString

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

startMigrationWorkflowCallable()

public final UnaryCallable<StartMigrationWorkflowRequest,Empty> startMigrationWorkflowCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   StartMigrationWorkflowRequest request =
       StartMigrationWorkflowRequest.newBuilder()
           .setName(MigrationWorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .build();
   ApiFuture<Empty> future =
       migrationServiceClient.startMigrationWorkflowCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<StartMigrationWorkflowRequest,Empty>