MigrationServiceClient (Google Cloud Vertex AI 1.0.1 API)

java.lang.Object
- com.google.cloud.aiplatform.v1.MigrationServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator-java")
public class MigrationServiceClient
extends Object
implements com.google.api.gax.core.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:
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:
```
 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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MigrationServiceClient.SearchMigratableResourcesFixedSizeCollection`
`static class`	`MigrationServiceClient.SearchMigratableResourcesPage`
`static class`	`MigrationServiceClient.SearchMigratableResourcesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`MigrationServiceClient(MigrationServiceSettings settings)` Constructs an instance of MigrationServiceClient, using the given settings.
`protected`	`MigrationServiceClient(MigrationServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`com.google.api.gax.longrunning.OperationFuture<BatchMigrateResourcesResponse,BatchMigrateResourcesOperationMetadata>`	`batchMigrateResourcesAsync(BatchMigrateResourcesRequest request)` Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
`com.google.api.gax.longrunning.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.
`com.google.api.gax.longrunning.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.
`com.google.api.gax.rpc.UnaryCallable<BatchMigrateResourcesRequest,com.google.longrunning.Operation>`	`batchMigrateResourcesCallable()` Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
`com.google.api.gax.rpc.OperationCallable<BatchMigrateResourcesRequest,BatchMigrateResourcesResponse,BatchMigrateResourcesOperationMetadata>`	`batchMigrateResourcesOperationCallable()` Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
`void`	`close()`
`static MigrationServiceClient`	`create()` Constructs an instance of MigrationServiceClient with default settings.
`static MigrationServiceClient`	`create(MigrationServiceSettings settings)` Constructs an instance of MigrationServiceClient, using the given settings.
`static MigrationServiceClient`	`create(MigrationServiceStub stub)` Constructs an instance of MigrationServiceClient, using the given stub for making calls.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`MigrationServiceSettings`	`getSettings()`
`MigrationServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`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.
`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.
`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.
`com.google.api.gax.rpc.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.
`com.google.api.gax.rpc.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.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- MigrationServiceClient
```
protected MigrationServiceClient(MigrationServiceSettings settings)
                          throws IOException
```
  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.
  
  Throws:
  
  IOException
- MigrationServiceClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected MigrationServiceClient(MigrationServiceStub stub)
```

Method Detail

create

public static final MigrationServiceClient create()
                                           throws IOException

Constructs an instance of MigrationServiceClient with default settings.

Throws:: IOException

create
```
public static final MigrationServiceClient create(MigrationServiceSettings settings)
                                           throws IOException
```
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.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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).

getSettings

public final MigrationServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public MigrationServiceStub getStub()

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

searchMigratableResources
```
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);
   }
 }
 
```
Parameters:

parent - 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}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

searchMigratableResources
```
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);
   }
 }
 
```
Parameters:

parent - 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}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

searchMigratableResources

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

searchMigratableResourcesPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

searchMigratableResourcesCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }