Class MigrationServiceClient (0.11.0)

publicclass MigrationServiceClientimplementsBackgroundResource

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");
MigrationWorkflowmigrationWorkflow=MigrationWorkflow.newBuilder().build();
MigrationWorkflowresponse=
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
MigrationServiceSettingsmigrationServiceSettings=
MigrationServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
MigrationServiceClientmigrationServiceClient=
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
MigrationServiceSettingsmigrationServiceSettings=
MigrationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
MigrationServiceClientmigrationServiceClient=
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
MigrationServiceSettingsmigrationServiceSettings=
MigrationServiceSettings.newHttpJsonBuilder().build();
MigrationServiceClientmigrationServiceClient=
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()

publicstaticfinalMigrationServiceClientcreate()

Constructs an instance of MigrationServiceClient with default settings.

Returns
Type Description
Exceptions
Type Description

create(MigrationServiceSettings settings)

publicstaticfinalMigrationServiceClientcreate(MigrationServiceSettingssettings)

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
Name Description
Returns
Type Description
Exceptions
Type Description

create(MigrationServiceStub stub)

publicstaticfinalMigrationServiceClientcreate(MigrationServiceStubstub)

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

Parameter
Name Description
Returns
Type Description

Constructors

MigrationServiceClient(MigrationServiceSettings settings)

protectedMigrationServiceClient(MigrationServiceSettingssettings)

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
Name Description

MigrationServiceClient(MigrationServiceStub stub)

protectedMigrationServiceClient(MigrationServiceStubstub)
Parameter
Name Description

Methods

awaitTermination(long duration, TimeUnit unit)

publicbooleanawaitTermination(longduration,TimeUnitunit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
Exceptions
Type Description

close()

publicfinalvoidclose()

createMigrationWorkflow(CreateMigrationWorkflowRequest request)

publicfinalMigrationWorkflowcreateMigrationWorkflow(CreateMigrationWorkflowRequestrequest)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
CreateMigrationWorkflowRequestrequest=
CreateMigrationWorkflowRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setMigrationWorkflow(MigrationWorkflow.newBuilder().build())
.build();
MigrationWorkflowresponse=migrationServiceClient.createMigrationWorkflow(request);
}
Parameter
Name Description
request CreateMigrationWorkflowRequest

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

Returns
Type Description

createMigrationWorkflow(LocationName parent, MigrationWorkflow migrationWorkflow)

publicfinalMigrationWorkflowcreateMigrationWorkflow(LocationNameparent,MigrationWorkflowmigrationWorkflow)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");
MigrationWorkflowmigrationWorkflow=MigrationWorkflow.newBuilder().build();
MigrationWorkflowresponse=
migrationServiceClient.createMigrationWorkflow(parent,migrationWorkflow);
}
Parameters
Name Description
parent LocationName

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

migrationWorkflow MigrationWorkflow

Required. The migration workflow to create.

Returns
Type Description

createMigrationWorkflow(String parent, MigrationWorkflow migrationWorkflow)

publicfinalMigrationWorkflowcreateMigrationWorkflow(Stringparent,MigrationWorkflowmigrationWorkflow)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
Stringparent=LocationName.of("[PROJECT]","[LOCATION]").toString();
MigrationWorkflowmigrationWorkflow=MigrationWorkflow.newBuilder().build();
MigrationWorkflowresponse=
migrationServiceClient.createMigrationWorkflow(parent,migrationWorkflow);
}
Parameters
Name Description
parent String

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

migrationWorkflow MigrationWorkflow

Required. The migration workflow to create.

Returns
Type Description

createMigrationWorkflowCallable()

publicfinalUnaryCallable<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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
CreateMigrationWorkflowRequestrequest=
CreateMigrationWorkflowRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setMigrationWorkflow(MigrationWorkflow.newBuilder().build())
.build();
ApiFuture<MigrationWorkflow>future=
migrationServiceClient.createMigrationWorkflowCallable().futureCall(request);
// Do something.
MigrationWorkflowresponse=future.get();
}
Returns
Type Description

deleteMigrationWorkflow(DeleteMigrationWorkflowRequest request)

publicfinalvoiddeleteMigrationWorkflow(DeleteMigrationWorkflowRequestrequest)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
DeleteMigrationWorkflowRequestrequest=
DeleteMigrationWorkflowRequest.newBuilder()
.setName(MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.build();
migrationServiceClient.deleteMigrationWorkflow(request);
}
Parameter
Name Description
request DeleteMigrationWorkflowRequest

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

deleteMigrationWorkflow(MigrationWorkflowName name)

publicfinalvoiddeleteMigrationWorkflow(MigrationWorkflowNamename)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
MigrationWorkflowNamename=
MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]");
migrationServiceClient.deleteMigrationWorkflow(name);
}
Parameter
Name Description
name MigrationWorkflowName

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

deleteMigrationWorkflow(String name)

publicfinalvoiddeleteMigrationWorkflow(Stringname)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
Stringname=MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString();
migrationServiceClient.deleteMigrationWorkflow(name);
}
Parameter
Name Description
name String

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

deleteMigrationWorkflowCallable()

publicfinalUnaryCallable<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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
DeleteMigrationWorkflowRequestrequest=
DeleteMigrationWorkflowRequest.newBuilder()
.setName(MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.build();
ApiFuture<Empty>future=
migrationServiceClient.deleteMigrationWorkflowCallable().futureCall(request);
// Do something.
future.get();
}
Returns
Type Description

getMigrationSubtask(GetMigrationSubtaskRequest request)

publicfinalMigrationSubtaskgetMigrationSubtask(GetMigrationSubtaskRequestrequest)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
GetMigrationSubtaskRequestrequest=
GetMigrationSubtaskRequest.newBuilder()
.setName(
MigrationSubtaskName.of("[PROJECT]","[LOCATION]","[WORKFLOW]","[SUBTASK]")
.toString())
.setReadMask(FieldMask.newBuilder().build())
.build();
MigrationSubtaskresponse=migrationServiceClient.getMigrationSubtask(request);
}
Parameter
Name Description
request GetMigrationSubtaskRequest

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

Returns
Type Description

getMigrationSubtask(MigrationSubtaskName name)

publicfinalMigrationSubtaskgetMigrationSubtask(MigrationSubtaskNamename)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
MigrationSubtaskNamename=
MigrationSubtaskName.of("[PROJECT]","[LOCATION]","[WORKFLOW]","[SUBTASK]");
MigrationSubtaskresponse=migrationServiceClient.getMigrationSubtask(name);
}
Parameter
Name Description
name MigrationSubtaskName

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

Returns
Type Description

getMigrationSubtask(String name)

publicfinalMigrationSubtaskgetMigrationSubtask(Stringname)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
Stringname=
MigrationSubtaskName.of("[PROJECT]","[LOCATION]","[WORKFLOW]","[SUBTASK]").toString();
MigrationSubtaskresponse=migrationServiceClient.getMigrationSubtask(name);
}
Parameter
Name Description
name String

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

Returns
Type Description

getMigrationSubtaskCallable()

publicfinalUnaryCallable<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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
GetMigrationSubtaskRequestrequest=
GetMigrationSubtaskRequest.newBuilder()
.setName(
MigrationSubtaskName.of("[PROJECT]","[LOCATION]","[WORKFLOW]","[SUBTASK]")
.toString())
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture<MigrationSubtask>future=
migrationServiceClient.getMigrationSubtaskCallable().futureCall(request);
// Do something.
MigrationSubtaskresponse=future.get();
}
Returns
Type Description

getMigrationWorkflow(GetMigrationWorkflowRequest request)

publicfinalMigrationWorkflowgetMigrationWorkflow(GetMigrationWorkflowRequestrequest)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
GetMigrationWorkflowRequestrequest=
GetMigrationWorkflowRequest.newBuilder()
.setName(MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.setReadMask(FieldMask.newBuilder().build())
.build();
MigrationWorkflowresponse=migrationServiceClient.getMigrationWorkflow(request);
}
Parameter
Name Description
request GetMigrationWorkflowRequest

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

Returns
Type Description

getMigrationWorkflow(MigrationWorkflowName name)

publicfinalMigrationWorkflowgetMigrationWorkflow(MigrationWorkflowNamename)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
MigrationWorkflowNamename=
MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]");
MigrationWorkflowresponse=migrationServiceClient.getMigrationWorkflow(name);
}
Parameter
Name Description
name MigrationWorkflowName

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

Returns
Type Description

getMigrationWorkflow(String name)

publicfinalMigrationWorkflowgetMigrationWorkflow(Stringname)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
Stringname=MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString();
MigrationWorkflowresponse=migrationServiceClient.getMigrationWorkflow(name);
}
Parameter
Name Description
name String

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

Returns
Type Description

getMigrationWorkflowCallable()

publicfinalUnaryCallable<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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
GetMigrationWorkflowRequestrequest=
GetMigrationWorkflowRequest.newBuilder()
.setName(MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture<MigrationWorkflow>future=
migrationServiceClient.getMigrationWorkflowCallable().futureCall(request);
// Do something.
MigrationWorkflowresponse=future.get();
}
Returns
Type Description

getSettings()

publicfinalMigrationServiceSettingsgetSettings()
Returns
Type Description

getStub()

publicMigrationServiceStubgetStub()
Returns
Type Description

isShutdown()

publicbooleanisShutdown()
Returns
Type Description

isTerminated()

publicbooleanisTerminated()
Returns
Type Description

listMigrationSubtasks(ListMigrationSubtasksRequest request)

publicfinalMigrationServiceClient.ListMigrationSubtasksPagedResponselistMigrationSubtasks(ListMigrationSubtasksRequestrequest)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
ListMigrationSubtasksRequestrequest=
ListMigrationSubtasksRequest.newBuilder()
.setParent(
MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.setReadMask(FieldMask.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for(MigrationSubtaskelement:
migrationServiceClient.listMigrationSubtasks(request).iterateAll()){
// doThingsWith(element);
}
}
Parameter
Name Description
request ListMigrationSubtasksRequest

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

Returns
Type Description

listMigrationSubtasks(MigrationWorkflowName parent)

publicfinalMigrationServiceClient.ListMigrationSubtasksPagedResponselistMigrationSubtasks(MigrationWorkflowNameparent)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
MigrationWorkflowNameparent=
MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]");
for(MigrationSubtaskelement:
migrationServiceClient.listMigrationSubtasks(parent).iterateAll()){
// doThingsWith(element);
}
}
Parameter
Name Description
parent MigrationWorkflowName

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

Returns
Type Description

listMigrationSubtasks(String parent)

publicfinalMigrationServiceClient.ListMigrationSubtasksPagedResponselistMigrationSubtasks(Stringparent)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
Stringparent=MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString();
for(MigrationSubtaskelement:
migrationServiceClient.listMigrationSubtasks(parent).iterateAll()){
// doThingsWith(element);
}
}
Parameter
Name Description
parent String

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

Returns
Type Description

listMigrationSubtasksCallable()

publicfinalUnaryCallable<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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
ListMigrationSubtasksRequestrequest=
ListMigrationSubtasksRequest.newBuilder()
.setParent(
MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.setReadMask(FieldMask.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while(true){
ListMigrationSubtasksResponseresponse=
migrationServiceClient.listMigrationSubtasksCallable().call(request);
for(MigrationSubtaskelement:response.getMigrationSubtasksList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
Returns
Type Description

listMigrationSubtasksPagedCallable()

publicfinalUnaryCallable<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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
ListMigrationSubtasksRequestrequest=
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(MigrationSubtaskelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
Returns
Type Description

listMigrationWorkflows(ListMigrationWorkflowsRequest request)

publicfinalMigrationServiceClient.ListMigrationWorkflowsPagedResponselistMigrationWorkflows(ListMigrationWorkflowsRequestrequest)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
ListMigrationWorkflowsRequestrequest=
ListMigrationWorkflowsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setReadMask(FieldMask.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for(MigrationWorkflowelement:
migrationServiceClient.listMigrationWorkflows(request).iterateAll()){
// doThingsWith(element);
}
}
Parameter
Name Description
request ListMigrationWorkflowsRequest

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

Returns
Type Description

listMigrationWorkflows(LocationName parent)

publicfinalMigrationServiceClient.ListMigrationWorkflowsPagedResponselistMigrationWorkflows(LocationNameparent)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");
for(MigrationWorkflowelement:
migrationServiceClient.listMigrationWorkflows(parent).iterateAll()){
// doThingsWith(element);
}
}
Parameter
Name Description
parent LocationName

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

Returns
Type Description

listMigrationWorkflows(String parent)

publicfinalMigrationServiceClient.ListMigrationWorkflowsPagedResponselistMigrationWorkflows(Stringparent)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
Stringparent=LocationName.of("[PROJECT]","[LOCATION]").toString();
for(MigrationWorkflowelement:
migrationServiceClient.listMigrationWorkflows(parent).iterateAll()){
// doThingsWith(element);
}
}
Parameter
Name Description
parent String

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

Returns
Type Description

listMigrationWorkflowsCallable()

publicfinalUnaryCallable<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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
ListMigrationWorkflowsRequestrequest=
ListMigrationWorkflowsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setReadMask(FieldMask.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while(true){
ListMigrationWorkflowsResponseresponse=
migrationServiceClient.listMigrationWorkflowsCallable().call(request);
for(MigrationWorkflowelement:response.getMigrationWorkflowsList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
Returns
Type Description

listMigrationWorkflowsPagedCallable()

publicfinalUnaryCallable<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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
ListMigrationWorkflowsRequestrequest=
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(MigrationWorkflowelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
Returns
Type Description

shutdown()

publicvoidshutdown()

shutdownNow()

publicvoidshutdownNow()

startMigrationWorkflow(MigrationWorkflowName name)

publicfinalvoidstartMigrationWorkflow(MigrationWorkflowNamename)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
MigrationWorkflowNamename=
MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]");
migrationServiceClient.startMigrationWorkflow(name);
}
Parameter
Name Description
name MigrationWorkflowName

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

startMigrationWorkflow(StartMigrationWorkflowRequest request)

publicfinalvoidstartMigrationWorkflow(StartMigrationWorkflowRequestrequest)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
StartMigrationWorkflowRequestrequest=
StartMigrationWorkflowRequest.newBuilder()
.setName(MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.build();
migrationServiceClient.startMigrationWorkflow(request);
}
Parameter
Name Description
request StartMigrationWorkflowRequest

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

startMigrationWorkflow(String name)

publicfinalvoidstartMigrationWorkflow(Stringname)

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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
Stringname=MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString();
migrationServiceClient.startMigrationWorkflow(name);
}
Parameter
Name Description
name String

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

startMigrationWorkflowCallable()

publicfinalUnaryCallable<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(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){
StartMigrationWorkflowRequestrequest=
StartMigrationWorkflowRequest.newBuilder()
.setName(MigrationWorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.build();
ApiFuture<Empty>future=
migrationServiceClient.startMigrationWorkflowCallable().futureCall(request);
// Do something.
future.get();
}
Returns
Type Description

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.