com.google.api.gax.rpc

Class UnaryCallable<RequestT,ResponseT>

java.lang.Object

com.google.api.gax.rpc.UnaryCallable<RequestT,ResponseT>

Direct Known Subclasses:

BatchingCallable, PagedCallable, TracedBatchingCallable, TracedUnaryCallable, TranslatingUnaryCallable

public abstract class UnaryCallable<RequestT,ResponseT>
extends Object

A UnaryCallable is an immutable object which is capable of making RPC calls to non-streaming API methods.

In typical usage, the request to send to the remote service will not be bound to the UnaryCallable, but instead is provided at call time, which allows for a UnaryCallable to be saved and used indefinitely.

There are two styles of calls that can be made through a UnaryCallable: synchronous and asynchronous.

Synchronous example:

 RequestType request = RequestType.newBuilder().build();
 UnaryCallable<RequestType, ResponseType> unaryCallable = api.doSomethingCallable();
 ResponseType response = unaryCallable.call();
 

Asynchronous example:

 RequestType request = RequestType.newBuilder().build();
 UnaryCallable<RequestType, ResponseType> unaryCallable = api.doSomethingCallable();
 ApiFuture<ResponseType> resultFuture = unaryCallable.futureCall();
 // do other work
 // ...
 ResponseType response = resultFuture.get();
 

It is considered advanced usage for a user to create a UnaryCallable themselves. This class is intended to be created by a generated client class, and configured by instances of UnaryCallSettings.Builder which are exposed through the client settings class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnaryCallable()

Method Summary

Modifier and Type	Method and Description
ResponseT	call(RequestT request) Same as call(Object, ApiCallContext), with a null context.
ResponseT	call(RequestT request, ApiCallContext context) Perform a call synchronously.
com.google.api.core.ApiFuture<ResponseT>	futureCall(RequestT request) Same as futureCall(Object, ApiCallContext), with a null context.
abstract com.google.api.core.ApiFuture<ResponseT>	futureCall(RequestT request, ApiCallContext context) Perform a call asynchronously.
UnaryCallable<RequestT,ResponseT>	withDefaultCallContext(ApiCallContext defaultCallContext) Returns a new UnaryCallable with an ApiCallContext that is used as a default when none is supplied in individual calls.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnaryCallable

protected UnaryCallable()

Method Detail

futureCall

public abstract com.google.api.core.ApiFuture<ResponseT> futureCall(RequestT request,
                                                                    ApiCallContext context)

Perform a call asynchronously.

Parameters:

context - ApiCallContext to make the call with

Returns:

ApiFuture for the call result

futureCall

public com.google.api.core.ApiFuture<ResponseT> futureCall(RequestT request)

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

Parameters:

request - request

Returns:

ApiFuture for the call result

call

public ResponseT call(RequestT request,
                      ApiCallContext context)

Perform a call synchronously.

Parameters:

request - The request to send to the service.

context - ApiCallContext to make the call with

Returns:

the call result

Throws:

ApiException - if there is any bad status in the response.

RuntimeException - if there is any other exception unrelated to bad status.

call

public ResponseT call(RequestT request)

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

Parameters:

request - The request to send to the service.

Returns:

the call result

Throws:

ApiException - if there is any bad status in the response.

RuntimeException - if there is any other exception unrelated to bad status.

withDefaultCallContext

public UnaryCallable<RequestT,ResponseT> withDefaultCallContext(ApiCallContext defaultCallContext)

Returns a new UnaryCallable with an ApiCallContext that is used as a default when none is supplied in individual calls.

Parameters:

defaultCallContext - the default ApiCallContext.