Classes
OperationsClient
Service Description: Manages long-running operations with an API service.
When an API method normally takes long time to complete, it can be designed to return
Operation to the client, and the client can use this interface to
receive the real response asynchronously by polling the operation resource, or pass the operation
resource to another API (such as Google Cloud Pub/Sub API) to receive the response. Any API
service that returns long-running operations should implement the Operations interface so
developers can have a consistent client experience.
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 (OperationsClient operationsClient = OperationsClient.create()) {
String name = "name3373707";
Operation response = operationsClient.getOperation(name);
}
Note: close() needs to be called on the OperationsClient 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 OperationsSettings to create(). For example:
To customize credentials:
OperationsSettings operationsSettings =
OperationsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
OperationsClient operationsClient = OperationsClient.create(operationsSettings);
To customize the endpoint:
OperationsSettings operationsSettings =
OperationsSettings.newBuilder().setEndpoint(myEndpoint).build();
OperationsClient operationsClient = OperationsClient.create(operationsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
OperationsClient.ListOperationsFixedSizeCollection
OperationsClient.ListOperationsPage
OperationsClient.ListOperationsPagedResponse
OperationsSettings
Settings class to configure an instance of OperationsClient.
The default instance has everything set to sensible defaults:
- The default service address (longrunning.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 getOperation to 30 seconds:
OperationsSettings.Builder operationsSettingsBuilder = OperationsSettings.newBuilder();
operationsSettingsBuilder
.getOperationSettings()
.setRetrySettings(
operationsSettingsBuilder
.getOperationSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
OperationsSettings operationsSettings = operationsSettingsBuilder.build();
OperationsSettings.Builder
Builder for OperationsSettings.