Class OperationCallable<RequestT,ResponseT,MetadataT> (2.15.0)

Version 2.15.0

• 2.55.0 (latest)
• 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

public abstract class 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.

Inheritance

java.lang.Object > OperationCallable<RequestT,ResponseT,MetadataT>

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameters

Name	Description
RequestT
ResponseT
MetadataT

Constructors

OperationCallable()

protected OperationCallable()

Methods

call(RequestT request)

public ResponseT call(RequestT request)

Same as #call(Object, ApiCallContext), with a null context.

Parameter

Name	Description
request	RequestT The request to initiate the operation.

Returns

Type	Description
ResponseT	the call result

call(RequestT request, ApiCallContext context)

public ResponseT call(RequestT request, ApiCallContext context)

Perform a call synchronously.

Parameters

Name	Description
request	RequestT The request to initiate the operation.
context	ApiCallContext ApiCallContext to make the call with

Returns

Type	Description
ResponseT	the call result

cancel(String operationName)

public ApiFuture<Void> cancel(String operationName)

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
com.google.api.core.ApiFuture<Void>	the future which completes once the operation is canceled on the server side.

cancel(String operationName, ApiCallContext context)

public abstract ApiFuture<Void> cancel(String operationName, ApiCallContext context)

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
com.google.api.core.ApiFuture<Void>	the future which completes once the operation is canceled on the server side.

futureCall(RequestT request)

public OperationFuture<ResponseT,MetadataT> futureCall(RequestT request)

Same as #futureCall(Object, ApiCallContext), with a null context.

Parameter

Name	Description
request	RequestT request

Returns

Type	Description
OperationFuture<ResponseT,MetadataT>	ApiFuture for the call result

futureCall(RequestT request, ApiCallContext context)

public abstract OperationFuture<ResponseT,MetadataT> futureCall(RequestT request, ApiCallContext context)

Initiates an operation asynchronously.

Parameters

Name	Description
request	RequestT The 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)

public OperationFuture<ResponseT,MetadataT> resumeFutureCall(String operationName)

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)

public abstract OperationFuture<ResponseT,MetadataT> resumeFutureCall(String operationName, ApiCallContext context)

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)

public OperationCallable<RequestT,ResponseT,MetadataT> withDefaultCallContext(ApiCallContext defaultCallContext)

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>