Package com.google.api.gax.rpc

Class Callables

java.lang.Object

com.google.api.gax.rpc.Callables

@BetaApi
public class Callables
extends Object

Class with utility methods to create callable objects using provided settings.

The callable objects wrap a given direct callable with features like retry and exception translation.

Method Summary

Modifier and Type	Method	Description
static <RequestT, ResponseT> UnaryCallable<RequestT,ResponseT>	batching(UnaryCallable<RequestT,ResponseT> innerCallable, BatchingCallSettings<RequestT,ResponseT> batchingCallSettings, ClientContext context)	Create a callable object that represents a batching API method.
static <RequestT, ResponseT, MetadataT> OperationCallable<RequestT,ResponseT,MetadataT>	longRunningOperation(UnaryCallable<RequestT,OperationSnapshot> initialCallable, OperationCallSettings<RequestT,ResponseT,MetadataT> operationCallSettings, ClientContext clientContext, LongRunningClient longRunningClient)	Creates a callable object that represents a long-running operation.
static <RequestT, ResponseT, PagedListResponseT> UnaryCallable<RequestT,PagedListResponseT>	paged(UnaryCallable<RequestT,ResponseT> innerCallable, PagedCallSettings<RequestT,ResponseT,PagedListResponseT> pagedCallSettings)	Create a paged callable object that represents a paged API method.
static <RequestT, ResponseT> ServerStreamingCallable<RequestT,ResponseT>	retrying(ServerStreamingCallable<RequestT,ResponseT> innerCallable, ServerStreamingCallSettings<RequestT,ResponseT> callSettings, ClientContext clientContext)
static <RequestT, ResponseT> UnaryCallable<RequestT,ResponseT>	retrying(UnaryCallable<RequestT,ResponseT> innerCallable, UnaryCallSettings<?,?> callSettings, ClientContext clientContext)	Create a callable object that represents a Unary API method.
static <RequestT, ResponseT> UnaryCallable<RequestT,ResponseT>	retrying(UnaryCallable<RequestT,ResponseT> innerCallable, UnaryCallSettings<?,?> callSettings, ClientContext clientContext, RequestMutator requestMutator)	Create a callable object that represents a Unary API method that contains a Request Mutator.
static <RequestT, ResponseT> ServerStreamingCallable<RequestT,ResponseT>	watched(ServerStreamingCallable<RequestT,ResponseT> callable, ServerStreamingCallSettings<RequestT,ResponseT> callSettings, ClientContext clientContext)

Methods inherited from class java.lang.Object

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

Method Details

retrying

public static <RequestT,
ResponseT>
UnaryCallable<RequestT,ResponseT> retrying(UnaryCallable<RequestT,ResponseT> innerCallable,
 UnaryCallSettings<?,?> callSettings,
 ClientContext clientContext)

Create a callable object that represents a Unary API method. Designed for use by generated code.

Parameters:

innerCallable - the callable to issue calls

callSettings - UnaryCallSettings to configure the unary call-related settings with.

clientContext - ClientContext to use to connect to the service.

Returns:

UnaryCallable callable object.

retrying

public static <RequestT,
ResponseT>
UnaryCallable<RequestT,ResponseT> retrying(UnaryCallable<RequestT,ResponseT> innerCallable,
 UnaryCallSettings<?,?> callSettings,
 ClientContext clientContext,
 RequestMutator requestMutator)

Create a callable object that represents a Unary API method that contains a Request Mutator. Designed for use by generated code.

Parameters:

innerCallable - the callable to issue calls

callSettings - UnaryCallSettings to configure the unary call-related settings with.

clientContext - ClientContext to use to connect to the service.

requestMutator - RequestMutator to modify the request. Currently only used for autopopulated fields.

Returns:

UnaryCallable callable object.

retrying

public static <RequestT,
ResponseT>
ServerStreamingCallable<RequestT,ResponseT> retrying(ServerStreamingCallable<RequestT,ResponseT> innerCallable,
 ServerStreamingCallSettings<RequestT,ResponseT> callSettings,
 ClientContext clientContext)

watched

public static <RequestT,
ResponseT>
ServerStreamingCallable<RequestT,ResponseT> watched(ServerStreamingCallable<RequestT,ResponseT> callable,
 ServerStreamingCallSettings<RequestT,ResponseT> callSettings,
 ClientContext clientContext)

batching

public static <RequestT,
ResponseT>
UnaryCallable<RequestT,ResponseT> batching(UnaryCallable<RequestT,ResponseT> innerCallable,
 BatchingCallSettings<RequestT,ResponseT> batchingCallSettings,
 ClientContext context)

Create a callable object that represents a batching API method. Designed for use by generated code.

Parameters:

innerCallable - the callable to issue calls

batchingCallSettings - BatchingSettings to configure the batching related settings with.

context - ClientContext to use to connect to the service.

Returns:

UnaryCallable callable object.

paged

public static <RequestT,
ResponseT,
PagedListResponseT>
UnaryCallable<RequestT,PagedListResponseT> paged(UnaryCallable<RequestT,ResponseT> innerCallable,
 PagedCallSettings<RequestT,ResponseT,PagedListResponseT> pagedCallSettings)

Create a paged callable object that represents a paged API method. Designed for use by generated code.

Parameters:

innerCallable - the callable to issue calls

pagedCallSettings - PagedCallSettings to configure the paged settings with.

Returns:

UnaryCallable callable object.

longRunningOperation

public static <RequestT,
ResponseT,
MetadataT>
OperationCallable<RequestT,ResponseT,MetadataT> longRunningOperation(UnaryCallable<RequestT,OperationSnapshot> initialCallable,
 OperationCallSettings<RequestT,ResponseT,MetadataT> operationCallSettings,
 ClientContext clientContext,
 LongRunningClient longRunningClient)

Creates a callable object that represents a long-running operation. Designed for use by generated code.

Parameters:

initialCallable - the callable that initiates the operation

operationCallSettings - OperationCallSettings to configure the method-level settings with.

clientContext - ClientContext to use to connect to the service.

longRunningClient - LongRunningClient to use to poll for updates on the Operation.

Returns:

OperationCallable callable object.