Package com.google.cloud.rapidmigrationassessment.v1 (0.12.0)

A client to Rapid Migration Assessment API

The interfaces provided are listed below, along with usage samples.

RapidMigrationAssessmentClient

Service Description: Service describing handlers for resources.

Sample for RapidMigrationAssessmentClient:


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

Classes

Annotation

Message describing an Annotation

Protobuf type google.cloud.rapidmigrationassessment.v1.Annotation

Annotation.Builder

Message describing an Annotation

Protobuf type google.cloud.rapidmigrationassessment.v1.Annotation

AnnotationName.Builder

Builder for projects/{project}/locations/{location}/annotations/{annotation}.

Collector

Message describing Collector object.

Protobuf type google.cloud.rapidmigrationassessment.v1.Collector

Collector.Builder

Message describing Collector object.

Protobuf type google.cloud.rapidmigrationassessment.v1.Collector

CollectorName.Builder

Builder for projects/{project}/locations/{location}/collectors/{collector}.

CreateAnnotationRequest

Message for creating an AnnotationS.

Protobuf type google.cloud.rapidmigrationassessment.v1.CreateAnnotationRequest

CreateAnnotationRequest.Builder

Message for creating an AnnotationS.

Protobuf type google.cloud.rapidmigrationassessment.v1.CreateAnnotationRequest

CreateCollectorRequest

Message for creating a Collector.

Protobuf type google.cloud.rapidmigrationassessment.v1.CreateCollectorRequest

CreateCollectorRequest.Builder

Message for creating a Collector.

Protobuf type google.cloud.rapidmigrationassessment.v1.CreateCollectorRequest

DeleteCollectorRequest

Message for deleting a Collector.

Protobuf type google.cloud.rapidmigrationassessment.v1.DeleteCollectorRequest

DeleteCollectorRequest.Builder

Message for deleting a Collector.

Protobuf type google.cloud.rapidmigrationassessment.v1.DeleteCollectorRequest

GetAnnotationRequest

Message for getting a specific Annotation

Protobuf type google.cloud.rapidmigrationassessment.v1.GetAnnotationRequest

GetAnnotationRequest.Builder

Message for getting a specific Annotation

Protobuf type google.cloud.rapidmigrationassessment.v1.GetAnnotationRequest

GetCollectorRequest

Message for getting a specific Collector.

Protobuf type google.cloud.rapidmigrationassessment.v1.GetCollectorRequest

GetCollectorRequest.Builder

Message for getting a specific Collector.

Protobuf type google.cloud.rapidmigrationassessment.v1.GetCollectorRequest

GuestOsScan

Message describing a MC Source of type Guest OS Scan.

Protobuf type google.cloud.rapidmigrationassessment.v1.GuestOsScan

GuestOsScan.Builder

Message describing a MC Source of type Guest OS Scan.

Protobuf type google.cloud.rapidmigrationassessment.v1.GuestOsScan

ListCollectorsRequest

Message for requesting list of Collectors.

Protobuf type google.cloud.rapidmigrationassessment.v1.ListCollectorsRequest

ListCollectorsRequest.Builder

Message for requesting list of Collectors.

Protobuf type google.cloud.rapidmigrationassessment.v1.ListCollectorsRequest

ListCollectorsResponse

Message for response to listing Collectors.

Protobuf type google.cloud.rapidmigrationassessment.v1.ListCollectorsResponse

ListCollectorsResponse.Builder

Message for response to listing Collectors.

Protobuf type google.cloud.rapidmigrationassessment.v1.ListCollectorsResponse

LocationName.Builder

Builder for projects/{project}/locations/{location}.

OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.rapidmigrationassessment.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.rapidmigrationassessment.v1.OperationMetadata

PauseCollectorRequest

Message for pausing a Collector.

Protobuf type google.cloud.rapidmigrationassessment.v1.PauseCollectorRequest

PauseCollectorRequest.Builder

Message for pausing a Collector.

Protobuf type google.cloud.rapidmigrationassessment.v1.PauseCollectorRequest

RapidMigrationAssessmentClient

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().

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

The default service address (rapidmigrationassessment.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getAnnotation to 30 seconds:


 // 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.Builder rapidMigrationAssessmentSettingsBuilder =
     RapidMigrationAssessmentSettings.newBuilder();
 rapidMigrationAssessmentSettingsBuilder
     .getAnnotationSettings()
     .setRetrySettings(
         rapidMigrationAssessmentSettingsBuilder
             .getAnnotationSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RapidMigrationAssessmentSettings rapidMigrationAssessmentSettings =
     rapidMigrationAssessmentSettingsBuilder.build();

Enums

Annotation.Type

Types for project level setting.

Protobuf enum google.cloud.rapidmigrationassessment.v1.Annotation.Type

Collector.State

-- Using suggestion from API Linter Analyzer for nesting enum -- -- https://linter.aip.dev/216/nesting -- State of a Collector (server_side). States are used for internal purposes and named to keep convention of legacy product: https://cloud.google.com/migrate/stratozone/docs/about-stratoprobe.

Protobuf enum google.cloud.rapidmigrationassessment.v1.Collector.State

Package com.google.cloud.rapidmigrationassessment.v1 (0.12.0)

RapidMigrationAssessmentClient

Classes

Interfaces

Enums