Class MigrationServiceClient (2.8.9)

public class MigrationServiceClient implements BackgroundResource

Service Description: A service that migrates resources from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.

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:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (MigratableResource element :
       migrationServiceClient.searchMigratableResources(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

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:

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.
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.
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:


 MigrationServiceSettings migrationServiceSettings =
     MigrationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MigrationServiceClient migrationServiceClient =
     MigrationServiceClient.create(migrationServiceSettings);

To customize the endpoint:


 MigrationServiceSettings migrationServiceSettings =
     MigrationServiceSettings.newBuilder().setEndpoint(myEndpoint).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

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final MigrationServiceClient create()

Constructs an instance of MigrationServiceClient with default settings.

Returns

Type	Description
MigrationServiceClient

Exceptions

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

Name	Description
settings	`MigrationServiceSettings`

Returns

Type	Description
MigrationServiceClient

Exceptions

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

Name	Description
stub	`MigrationServiceStub`

Returns

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

Name	Description
settings	`MigrationServiceSettings`

MigrationServiceClient(MigrationServiceStub stub)

protected MigrationServiceClient(MigrationServiceStub stub)

Parameter

Name	Description
stub	`MigrationServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	`long`
unit	`TimeUnit`

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

batchMigrateResourcesAsync(BatchMigrateResourcesRequest request)

public final OperationFuture<BatchMigrateResourcesResponse,BatchMigrateResourcesOperationMetadata> batchMigrateResourcesAsync(BatchMigrateResourcesRequest request)

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

Sample code:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   BatchMigrateResourcesRequest request =
       BatchMigrateResourcesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllMigrateResourceRequests(new ArrayList<MigrateResourceRequest>())
           .build();
   BatchMigrateResourcesResponse response =
       migrationServiceClient.batchMigrateResourcesAsync(request).get();
 }

Parameter

Name	Description
request	`BatchMigrateResourcesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<BatchMigrateResourcesResponse,BatchMigrateResourcesOperationMetadata>

batchMigrateResourcesAsync(LocationName parent, List<MigrateResourceRequest> migrateResourceRequests)

public final OperationFuture<BatchMigrateResourcesResponse,BatchMigrateResourcesOperationMetadata> batchMigrateResourcesAsync(LocationName parent, List<MigrateResourceRequest> migrateResourceRequests)

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

Sample code:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   List<MigrateResourceRequest> migrateResourceRequests = new ArrayList<>();
   BatchMigrateResourcesResponse response =
       migrationServiceClient.batchMigrateResourcesAsync(parent, migrateResourceRequests).get();
 }

Parameters

Name	Description
parent	`LocationName` Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`
migrateResourceRequests	`List<MigrateResourceRequest>` Required. The request messages specifying the resources to migrate. They must be in the same location as the destination. Up to 50 resources can be migrated in one batch.

Returns

Type	Description
OperationFuture<BatchMigrateResourcesResponse,BatchMigrateResourcesOperationMetadata>

batchMigrateResourcesAsync(String parent, List<MigrateResourceRequest> migrateResourceRequests)

public final OperationFuture<BatchMigrateResourcesResponse,BatchMigrateResourcesOperationMetadata> batchMigrateResourcesAsync(String parent, List<MigrateResourceRequest> migrateResourceRequests)

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

Sample code:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   List<MigrateResourceRequest> migrateResourceRequests = new ArrayList<>();
   BatchMigrateResourcesResponse response =
       migrationServiceClient.batchMigrateResourcesAsync(parent, migrateResourceRequests).get();
 }

Parameters

Name	Description
parent	`String` Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`
migrateResourceRequests	`List<MigrateResourceRequest>` Required. The request messages specifying the resources to migrate. They must be in the same location as the destination. Up to 50 resources can be migrated in one batch.

Returns

Type	Description
OperationFuture<BatchMigrateResourcesResponse,BatchMigrateResourcesOperationMetadata>

batchMigrateResourcesCallable()

public final UnaryCallable<BatchMigrateResourcesRequest,Operation> batchMigrateResourcesCallable()

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

Sample code:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   BatchMigrateResourcesRequest request =
       BatchMigrateResourcesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllMigrateResourceRequests(new ArrayList<MigrateResourceRequest>())
           .build();
   ApiFuture<Operation> future =
       migrationServiceClient.batchMigrateResourcesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<BatchMigrateResourcesRequest,Operation>

batchMigrateResourcesOperationCallable()

public final OperationCallable<BatchMigrateResourcesRequest,BatchMigrateResourcesResponse,BatchMigrateResourcesOperationMetadata> batchMigrateResourcesOperationCallable()

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

Sample code:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   BatchMigrateResourcesRequest request =
       BatchMigrateResourcesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllMigrateResourceRequests(new ArrayList<MigrateResourceRequest>())
           .build();
   OperationFuture<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata>
       future =
           migrationServiceClient.batchMigrateResourcesOperationCallable().futureCall(request);
   // Do something.
   BatchMigrateResourcesResponse response = future.get();
 }

Returns

Type	Description
OperationCallable<BatchMigrateResourcesRequest,BatchMigrateResourcesResponse,BatchMigrateResourcesOperationMetadata>

close()

public final void close()

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final MigrationServiceSettings getSettings()

Returns

Type	Description
MigrationServiceSettings

getStub()

public MigrationServiceStub getStub()

Returns

Type	Description
MigrationServiceStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

searchMigratableResources(LocationName parent)

public final MigrationServiceClient.SearchMigratableResourcesPagedResponse searchMigratableResources(LocationName parent)

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

Sample code:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (MigratableResource element :
       migrationServiceClient.searchMigratableResources(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`LocationName` Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project}/locations/{location}`

Returns

Type	Description
MigrationServiceClient.SearchMigratableResourcesPagedResponse

searchMigratableResources(SearchMigratableResourcesRequest request)

public final MigrationServiceClient.SearchMigratableResourcesPagedResponse searchMigratableResources(SearchMigratableResourcesRequest request)

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

Sample code:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   SearchMigratableResourcesRequest request =
       SearchMigratableResourcesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (MigratableResource element :
       migrationServiceClient.searchMigratableResources(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`SearchMigratableResourcesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
MigrationServiceClient.SearchMigratableResourcesPagedResponse

searchMigratableResources(String parent)

public final MigrationServiceClient.SearchMigratableResourcesPagedResponse searchMigratableResources(String parent)

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

Sample code:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (MigratableResource element :
       migrationServiceClient.searchMigratableResources(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project}/locations/{location}`

Returns

Type	Description
MigrationServiceClient.SearchMigratableResourcesPagedResponse

searchMigratableResourcesCallable()

public final UnaryCallable<SearchMigratableResourcesRequest,SearchMigratableResourcesResponse> searchMigratableResourcesCallable()

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

Sample code:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   SearchMigratableResourcesRequest request =
       SearchMigratableResourcesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     SearchMigratableResourcesResponse response =
         migrationServiceClient.searchMigratableResourcesCallable().call(request);
     for (MigratableResource element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<SearchMigratableResourcesRequest,SearchMigratableResourcesResponse>

searchMigratableResourcesPagedCallable()

public final UnaryCallable<SearchMigratableResourcesRequest,MigrationServiceClient.SearchMigratableResourcesPagedResponse> searchMigratableResourcesPagedCallable()

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

Sample code:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   SearchMigratableResourcesRequest request =
       SearchMigratableResourcesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<MigratableResource> future =
       migrationServiceClient.searchMigratableResourcesPagedCallable().futureCall(request);
   // Do something.
   for (MigratableResource element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<SearchMigratableResourcesRequest,SearchMigratableResourcesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()