Class OperationCallable<RequestT,ResponseT,MetadataT> (2.72.1)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.72.1 (latest)
- 2.71.0
- 2.70.3
- 2.69.0
- 2.68.2
- 2.67.0
- 2.66.0
- 2.65.0
- 2.63.1
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.1
- 2.58.0
- 2.57.0
- 2.55.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.1
- 2.47.0
- 2.46.1
- 2.45.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.1
- 2.33.0
- 2.32.1
- 2.31.1
- 2.30.1
- 2.24.0
- 2.23.3
- 2.22.0
- 2.21.0
- 2.20.1
- 2.19.6
- 2.18.7
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.2
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.1
- 2.7.1
publicabstractclass OperationCallable<RequestT,ResponseT,MetadataT>An OperationCallable is an immutable object which is capable of initiating RPC calls to long-running API methods and returning an OperationFuture to manage the polling of the Operation and getting the response.
It is considered advanced usage for a user to create an OperationCallable themselves. This class is intended to be created by a generated client class, and configured by instances of OperationCallSettings.Builder which are exposed through the client settings class.
Inherited Members
Type Parameters |
|
|---|---|
| Name | Description |
RequestT |
|
ResponseT |
|
MetadataT |
|
Constructors
OperationCallable()
protectedOperationCallable()Methods
call(RequestT request)
publicResponseTcall(RequestTrequest)Same as #call(Object, ApiCallContext), with a null context.
| Parameter | |
|---|---|
| Name | Description |
request |
RequestTThe request to initiate the operation. |
| Returns | |
|---|---|
| Type | Description |
ResponseT |
the call result |
call(RequestT request, ApiCallContext context)
publicResponseTcall(RequestTrequest,ApiCallContextcontext)Perform a call synchronously.
| Parameters | |
|---|---|
| Name | Description |
request |
RequestTThe request to initiate the operation. |
context |
ApiCallContext ApiCallContext to make the call with |
| Returns | |
|---|---|
| Type | Description |
ResponseT |
the call result |
cancel(String operationName)
publicApiFuture<Void>cancel(StringoperationName)Sends a cancellation request to the server for the operation with name operationName.
| Parameter | |
|---|---|
| Name | Description |
operationName |
String The name of the operation to cancel. |
| Returns | |
|---|---|
| Type | Description |
ApiFuture<Void> |
the future which completes once the operation is canceled on the server side. |
cancel(String operationName, ApiCallContext context)
publicabstractApiFuture<Void>cancel(StringoperationName,ApiCallContextcontext)Sends a cancellation request to the server for the operation with name operationName.
| Parameters | |
|---|---|
| Name | Description |
operationName |
String The name of the operation to cancel. |
context |
ApiCallContext ApiCallContext to make the call with |
| Returns | |
|---|---|
| Type | Description |
ApiFuture<Void> |
the future which completes once the operation is canceled on the server side. |
futureCall(RequestT request)
publicOperationFuture<ResponseT,MetadataT>futureCall(RequestTrequest)Same as #futureCall(Object, ApiCallContext), with a null context.
| Parameter | |
|---|---|
| Name | Description |
request |
RequestTrequest |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<ResponseT,MetadataT> |
ApiFuture for the call result |
futureCall(RequestT request, ApiCallContext context)
publicabstractOperationFuture<ResponseT,MetadataT>futureCall(RequestTrequest,ApiCallContextcontext)Initiates an operation asynchronously.
| Parameters | |
|---|---|
| Name | Description |
request |
RequestTThe request to initiate the operation. |
context |
ApiCallContext ApiCallContext to make the call with |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<ResponseT,MetadataT> |
OperationFuture for the call result |
resumeFutureCall(String operationName)
publicOperationFuture<ResponseT,MetadataT>resumeFutureCall(StringoperationName)Creates a new OperationFuture to watch an operation that has been initiated previously. Note: This is not type-safe at static time; the result type can only be checked once the operation finishes.
| Parameter | |
|---|---|
| Name | Description |
operationName |
String The name of the operation to resume. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<ResponseT,MetadataT> |
OperationFuture for the call result. |
resumeFutureCall(String operationName, ApiCallContext context)
publicabstractOperationFuture<ResponseT,MetadataT>resumeFutureCall(StringoperationName,ApiCallContextcontext)Creates a new OperationFuture to watch an operation that has been initiated previously. Note: This is not type-safe at static time; the result type can only be checked once the operation finishes.
| Parameters | |
|---|---|
| Name | Description |
operationName |
String The name of the operation to resume. |
context |
ApiCallContext ApiCallContext to make the call with |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<ResponseT,MetadataT> |
OperationFuture for the call result. |
withDefaultCallContext(ApiCallContext defaultCallContext)
publicOperationCallable<RequestT,ResponseT,MetadataT>withDefaultCallContext(ApiCallContextdefaultCallContext)Returns a new OperationCallable with an ApiCallContext that is used as a
default when none is supplied in individual calls.
| Parameter | |
|---|---|
| Name | Description |
defaultCallContext |
ApiCallContext the default ApiCallContext. |
| Returns | |
|---|---|
| Type | Description |
OperationCallable<RequestT,ResponseT,MetadataT> |
|