RapidMigrationAssessmentClient (Google Rapid Migration Assessment API 0.16.0 API)

java.lang.Object
- com.google.cloud.rapidmigrationassessment.v1.RapidMigrationAssessmentClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class RapidMigrationAssessmentClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service describing handlers for resources.

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 (RapidMigrationAssessmentClient rapidMigrationAssessmentClient =
     RapidMigrationAssessmentClient.create()) {
   AnnotationName name = AnnotationName.of("[PROJECT]", "[LOCATION]", "[ANNOTATION]");
   Annotation response = rapidMigrationAssessmentClient.getAnnotation(name);
 }

Note: close() needs to be called on the RapidMigrationAssessmentClient 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
CreateCollector	Create a Collector to manage the on-prem appliance which collects information about Customer assets.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createCollectorAsync(CreateCollectorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createCollectorAsync(LocationName parent, Collector collector, String collectorId) createCollectorAsync(String parent, Collector collector, String collectorId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createCollectorOperationCallable() createCollectorCallable()
CreateAnnotation	Creates an Annotation	Request object method variants only take one parameter, a request object, which must be constructed before the call. createAnnotationAsync(CreateAnnotationRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createAnnotationAsync(LocationName parent, Annotation annotation) createAnnotationAsync(String parent, Annotation annotation) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createAnnotationOperationCallable() createAnnotationCallable()
GetAnnotation	Gets details of a single Annotation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getAnnotation(GetAnnotationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAnnotation(AnnotationName name) getAnnotation(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getAnnotationCallable()
ListCollectors	Lists Collectors in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCollectors(ListCollectorsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCollectors(LocationName parent) listCollectors(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCollectorsPagedCallable() listCollectorsCallable()
GetCollector	Gets details of a single Collector.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getCollector(GetCollectorRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCollector(CollectorName name) getCollector(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCollectorCallable()
UpdateCollector	Updates the parameters of a single Collector.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCollectorAsync(UpdateCollectorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateCollectorAsync(Collector collector, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateCollectorOperationCallable() updateCollectorCallable()
DeleteCollector	Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteCollectorAsync(DeleteCollectorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteCollectorAsync(CollectorName name) deleteCollectorAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteCollectorOperationCallable() deleteCollectorCallable()
ResumeCollector	Resumes the given collector.	Request object method variants only take one parameter, a request object, which must be constructed before the call. resumeCollectorAsync(ResumeCollectorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. resumeCollectorAsync(CollectorName name) resumeCollectorAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. resumeCollectorOperationCallable() resumeCollectorCallable()
RegisterCollector	Registers the given collector.	Request object method variants only take one parameter, a request object, which must be constructed before the call. registerCollectorAsync(RegisterCollectorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. registerCollectorAsync(CollectorName name) registerCollectorAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. registerCollectorOperationCallable() registerCollectorCallable()
PauseCollector	Pauses the given collector.	Request object method variants only take one parameter, a request object, which must be constructed before the call. pauseCollectorAsync(PauseCollectorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. pauseCollectorAsync(CollectorName name) pauseCollectorAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. pauseCollectorOperationCallable() pauseCollectorCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

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 RapidMigrationAssessmentSettings 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
 RapidMigrationAssessmentSettings rapidMigrationAssessmentSettings =
     RapidMigrationAssessmentSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RapidMigrationAssessmentClient rapidMigrationAssessmentClient =
     RapidMigrationAssessmentClient.create(rapidMigrationAssessmentSettings);

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
 RapidMigrationAssessmentSettings rapidMigrationAssessmentSettings =
     RapidMigrationAssessmentSettings.newBuilder().setEndpoint(myEndpoint).build();
 RapidMigrationAssessmentClient rapidMigrationAssessmentClient =
     RapidMigrationAssessmentClient.create(rapidMigrationAssessmentSettings);

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
 RapidMigrationAssessmentSettings rapidMigrationAssessmentSettings =
     RapidMigrationAssessmentSettings.newHttpJsonBuilder().build();
 RapidMigrationAssessmentClient rapidMigrationAssessmentClient =
     RapidMigrationAssessmentClient.create(rapidMigrationAssessmentSettings);

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`	`RapidMigrationAssessmentClient.ListCollectorsFixedSizeCollection`
`static class`	`RapidMigrationAssessmentClient.ListCollectorsPage`
`static class`	`RapidMigrationAssessmentClient.ListCollectorsPagedResponse`
`static class`	`RapidMigrationAssessmentClient.ListLocationsFixedSizeCollection`
`static class`	`RapidMigrationAssessmentClient.ListLocationsPage`
`static class`	`RapidMigrationAssessmentClient.ListLocationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RapidMigrationAssessmentClient(RapidMigrationAssessmentSettings settings)` Constructs an instance of RapidMigrationAssessmentClient, using the given settings.
`protected`	`RapidMigrationAssessmentClient(RapidMigrationAssessmentStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static RapidMigrationAssessmentClient`	`create()` Constructs an instance of RapidMigrationAssessmentClient with default settings.
`static RapidMigrationAssessmentClient`	`create(RapidMigrationAssessmentSettings settings)` Constructs an instance of RapidMigrationAssessmentClient, using the given settings.
`static RapidMigrationAssessmentClient`	`create(RapidMigrationAssessmentStub stub)` Constructs an instance of RapidMigrationAssessmentClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Annotation,OperationMetadata>`	`createAnnotationAsync(CreateAnnotationRequest request)` Creates an Annotation
`com.google.api.gax.longrunning.OperationFuture<Annotation,OperationMetadata>`	`createAnnotationAsync(LocationName parent, Annotation annotation)` Creates an Annotation
`com.google.api.gax.longrunning.OperationFuture<Annotation,OperationMetadata>`	`createAnnotationAsync(String parent, Annotation annotation)` Creates an Annotation
`com.google.api.gax.rpc.UnaryCallable<CreateAnnotationRequest,com.google.longrunning.Operation>`	`createAnnotationCallable()` Creates an Annotation
`com.google.api.gax.rpc.OperationCallable<CreateAnnotationRequest,Annotation,OperationMetadata>`	`createAnnotationOperationCallable()` Creates an Annotation
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`createCollectorAsync(CreateCollectorRequest request)` Create a Collector to manage the on-prem appliance which collects information about Customer assets.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`createCollectorAsync(LocationName parent, Collector collector, String collectorId)` Create a Collector to manage the on-prem appliance which collects information about Customer assets.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`createCollectorAsync(String parent, Collector collector, String collectorId)` Create a Collector to manage the on-prem appliance which collects information about Customer assets.
`com.google.api.gax.rpc.UnaryCallable<CreateCollectorRequest,com.google.longrunning.Operation>`	`createCollectorCallable()` Create a Collector to manage the on-prem appliance which collects information about Customer assets.
`com.google.api.gax.rpc.OperationCallable<CreateCollectorRequest,Collector,OperationMetadata>`	`createCollectorOperationCallable()` Create a Collector to manage the on-prem appliance which collects information about Customer assets.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`deleteCollectorAsync(CollectorName name)` Deletes a single Collector - changes state of collector to "Deleting".
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`deleteCollectorAsync(DeleteCollectorRequest request)` Deletes a single Collector - changes state of collector to "Deleting".
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`deleteCollectorAsync(String name)` Deletes a single Collector - changes state of collector to "Deleting".
`com.google.api.gax.rpc.UnaryCallable<DeleteCollectorRequest,com.google.longrunning.Operation>`	`deleteCollectorCallable()` Deletes a single Collector - changes state of collector to "Deleting".
`com.google.api.gax.rpc.OperationCallable<DeleteCollectorRequest,Collector,OperationMetadata>`	`deleteCollectorOperationCallable()` Deletes a single Collector - changes state of collector to "Deleting".
`Annotation`	`getAnnotation(AnnotationName name)` Gets details of a single Annotation.
`Annotation`	`getAnnotation(GetAnnotationRequest request)` Gets details of a single Annotation.
`Annotation`	`getAnnotation(String name)` Gets details of a single Annotation.
`com.google.api.gax.rpc.UnaryCallable<GetAnnotationRequest,Annotation>`	`getAnnotationCallable()` Gets details of a single Annotation.
`Collector`	`getCollector(CollectorName name)` Gets details of a single Collector.
`Collector`	`getCollector(GetCollectorRequest request)` Gets details of a single Collector.
`Collector`	`getCollector(String name)` Gets details of a single Collector.
`com.google.api.gax.rpc.UnaryCallable<GetCollectorRequest,Collector>`	`getCollectorCallable()` Gets details of a single Collector.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`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.
`RapidMigrationAssessmentSettings`	`getSettings()`
`RapidMigrationAssessmentStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`RapidMigrationAssessmentClient.ListCollectorsPagedResponse`	`listCollectors(ListCollectorsRequest request)` Lists Collectors in a given project and location.
`RapidMigrationAssessmentClient.ListCollectorsPagedResponse`	`listCollectors(LocationName parent)` Lists Collectors in a given project and location.
`RapidMigrationAssessmentClient.ListCollectorsPagedResponse`	`listCollectors(String parent)` Lists Collectors in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListCollectorsRequest,ListCollectorsResponse>`	`listCollectorsCallable()` Lists Collectors in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListCollectorsRequest,RapidMigrationAssessmentClient.ListCollectorsPagedResponse>`	`listCollectorsPagedCallable()` Lists Collectors in a given project and location.
`RapidMigrationAssessmentClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,RapidMigrationAssessmentClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`pauseCollectorAsync(CollectorName name)` Pauses the given collector.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`pauseCollectorAsync(PauseCollectorRequest request)` Pauses the given collector.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`pauseCollectorAsync(String name)` Pauses the given collector.
`com.google.api.gax.rpc.UnaryCallable<PauseCollectorRequest,com.google.longrunning.Operation>`	`pauseCollectorCallable()` Pauses the given collector.
`com.google.api.gax.rpc.OperationCallable<PauseCollectorRequest,Collector,OperationMetadata>`	`pauseCollectorOperationCallable()` Pauses the given collector.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`registerCollectorAsync(CollectorName name)` Registers the given collector.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`registerCollectorAsync(RegisterCollectorRequest request)` Registers the given collector.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`registerCollectorAsync(String name)` Registers the given collector.
`com.google.api.gax.rpc.UnaryCallable<RegisterCollectorRequest,com.google.longrunning.Operation>`	`registerCollectorCallable()` Registers the given collector.
`com.google.api.gax.rpc.OperationCallable<RegisterCollectorRequest,Collector,OperationMetadata>`	`registerCollectorOperationCallable()` Registers the given collector.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`resumeCollectorAsync(CollectorName name)` Resumes the given collector.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`resumeCollectorAsync(ResumeCollectorRequest request)` Resumes the given collector.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`resumeCollectorAsync(String name)` Resumes the given collector.
`com.google.api.gax.rpc.UnaryCallable<ResumeCollectorRequest,com.google.longrunning.Operation>`	`resumeCollectorCallable()` Resumes the given collector.
`com.google.api.gax.rpc.OperationCallable<ResumeCollectorRequest,Collector,OperationMetadata>`	`resumeCollectorOperationCallable()` Resumes the given collector.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`updateCollectorAsync(Collector collector, com.google.protobuf.FieldMask updateMask)` Updates the parameters of a single Collector.
`com.google.api.gax.longrunning.OperationFuture<Collector,OperationMetadata>`	`updateCollectorAsync(UpdateCollectorRequest request)` Updates the parameters of a single Collector.
`com.google.api.gax.rpc.UnaryCallable<UpdateCollectorRequest,com.google.longrunning.Operation>`	`updateCollectorCallable()` Updates the parameters of a single Collector.
`com.google.api.gax.rpc.OperationCallable<UpdateCollectorRequest,Collector,OperationMetadata>`	`updateCollectorOperationCallable()` Updates the parameters of a single Collector.

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

Constructor Detail
- RapidMigrationAssessmentClient
```
protected RapidMigrationAssessmentClient(RapidMigrationAssessmentSettings settings)
                                  throws IOException
```
  Constructs an instance of RapidMigrationAssessmentClient, 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
- RapidMigrationAssessmentClient
```
protected RapidMigrationAssessmentClient(RapidMigrationAssessmentStub stub)
```

Method Detail

create

public static final RapidMigrationAssessmentClient create()
                                                   throws IOException

Constructs an instance of RapidMigrationAssessmentClient with default settings.

Throws:: IOException

create
```
public static final RapidMigrationAssessmentClient create(RapidMigrationAssessmentSettings settings)
                                                   throws IOException
```
Constructs an instance of RapidMigrationAssessmentClient, 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
```
public static final RapidMigrationAssessmentClient create(RapidMigrationAssessmentStub stub)
```
Constructs an instance of RapidMigrationAssessmentClient, using the given stub for making calls. This is for advanced usage - prefer using create(RapidMigrationAssessmentSettings).

getSettings

public final RapidMigrationAssessmentSettings getSettings()

getStub

public RapidMigrationAssessmentStub 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.

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