Class MigrationServiceClient (0.52.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 0.83.0 (latest)
- 0.81.0
- 0.79.0
- 0.78.0
- 0.77.0
- 0.76.0
- 0.75.0
- 0.73.0
- 0.71.0
- 0.70.0
- 0.67.0
- 0.66.0
- 0.65.0
- 0.63.0
- 0.62.0
- 0.61.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.2
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.4
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().
| Method | Description | Method Variants |
|---|---|---|
CreateMigrationWorkflow |
Creates a migration workflow. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetMigrationWorkflow |
Gets a previously created migration workflow. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListMigrationWorkflows |
Lists previously created migration workflow. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteMigrationWorkflow |
Deletes a migration workflow by name. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
StartMigrationWorkflow |
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. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetMigrationSubtask |
Gets a previously created migration subtask. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListMigrationSubtasks |
Lists previously created migration subtasks. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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.
Static Methods
create()
publicstaticfinalMigrationServiceClientcreate()Constructs an instance of MigrationServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
MigrationServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
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 |
settings |
MigrationServiceSettings |
| Returns | |
|---|---|
| Type | Description |
MigrationServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
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 |
stub |
MigrationServiceStub |
| Returns | |
|---|---|
| Type | Description |
MigrationServiceClient |
|
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 |
settings |
MigrationServiceSettings |
MigrationServiceClient(MigrationServiceStub stub)
protectedMigrationServiceClient(MigrationServiceStubstub)| Parameter | |
|---|---|
| Name | Description |
stub |
MigrationServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
publicbooleanawaitTermination(longduration,TimeUnitunit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
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 |
MigrationWorkflow |
|
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: |
migrationWorkflow |
MigrationWorkflow Required. The migration workflow to create. |
| Returns | |
|---|---|
| Type | Description |
MigrationWorkflow |
|
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: |
migrationWorkflow |
MigrationWorkflow Required. The migration workflow to create. |
| Returns | |
|---|---|
| Type | Description |
MigrationWorkflow |
|
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 |
UnaryCallable<CreateMigrationWorkflowRequest,MigrationWorkflow> |
|
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:
|
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:
|
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 |
UnaryCallable<DeleteMigrationWorkflowRequest,Empty> |
|
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 |
MigrationSubtask |
|
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:
|
| Returns | |
|---|---|
| Type | Description |
MigrationSubtask |
|
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:
|
| Returns | |
|---|---|
| Type | Description |
MigrationSubtask |
|
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 |
UnaryCallable<GetMigrationSubtaskRequest,MigrationSubtask> |
|
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 |
MigrationWorkflow |
|
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:
|
| Returns | |
|---|---|
| Type | Description |
MigrationWorkflow |
|
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:
|
| Returns | |
|---|---|
| Type | Description |
MigrationWorkflow |
|
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 |
UnaryCallable<GetMigrationWorkflowRequest,MigrationWorkflow> |
|
getSettings()
publicfinalMigrationServiceSettingsgetSettings()| Returns | |
|---|---|
| Type | Description |
MigrationServiceSettings |
|
getStub()
publicMigrationServiceStubgetStub()| Returns | |
|---|---|
| Type | Description |
MigrationServiceStub |
|
isShutdown()
publicbooleanisShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
publicbooleanisTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
MigrationServiceClient.ListMigrationSubtasksPagedResponse |
|
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:
|
| Returns | |
|---|---|
| Type | Description |
MigrationServiceClient.ListMigrationSubtasksPagedResponse |
|
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:
|
| Returns | |
|---|---|
| Type | Description |
MigrationServiceClient.ListMigrationSubtasksPagedResponse |
|
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 |
UnaryCallable<ListMigrationSubtasksRequest,ListMigrationSubtasksResponse> |
|
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 |
UnaryCallable<ListMigrationSubtasksRequest,ListMigrationSubtasksPagedResponse> |
|
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 |
MigrationServiceClient.ListMigrationWorkflowsPagedResponse |
|
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:
|
| Returns | |
|---|---|
| Type | Description |
MigrationServiceClient.ListMigrationWorkflowsPagedResponse |
|
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:
|
| Returns | |
|---|---|
| Type | Description |
MigrationServiceClient.ListMigrationWorkflowsPagedResponse |
|
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 |
UnaryCallable<ListMigrationWorkflowsRequest,ListMigrationWorkflowsResponse> |
|
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 |
UnaryCallable<ListMigrationWorkflowsRequest,ListMigrationWorkflowsPagedResponse> |
|
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:
|
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:
|
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 |
UnaryCallable<StartMigrationWorkflowRequest,Empty> |
|