Class Callables (2.48.1)

public class Callables

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.

Inheritance

java.lang.Object > Callables

Static Methods

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

public static OperationCallable<RequestT,ResponseT,MetadataT> <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
Name Description
initialCallable UnaryCallable<RequestT,OperationSnapshot>

the callable that initiates the operation

operationCallSettings OperationCallSettings<RequestT,ResponseT,MetadataT>

OperationCallSettings to configure the method-level settings with.

clientContext ClientContext

ClientContext to use to connect to the service.

longRunningClient LongRunningClient

LongRunningClient to use to poll for updates on the Operation.

Returns
Type Description
OperationCallable<RequestT,ResponseT,MetadataT>

OperationCallable callable object.

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

public static UnaryCallable<RequestT,PagedListResponseT> <RequestT,ResponseT,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
Name Description
innerCallable UnaryCallable<RequestT,ResponseT>

the callable to issue calls

pagedCallSettings PagedCallSettings<RequestT,ResponseT,PagedListResponseT>

PagedCallSettings to configure the paged settings with.

Returns
Type Description
UnaryCallable<RequestT,PagedListResponseT>

UnaryCallable callable object.

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

public static UnaryCallable<RequestT,ResponseT> <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
Name Description
innerCallable UnaryCallable<RequestT,ResponseT>

the callable to issue calls

batchingCallSettings BatchingCallSettings<RequestT,ResponseT>

BatchingSettings to configure the batching related settings with.

context ClientContext

ClientContext to use to connect to the service.

Returns
Type Description
UnaryCallable<RequestT,ResponseT>

UnaryCallable callable object.

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

public static ServerStreamingCallable<RequestT,ResponseT> <RequestT,ResponseT>retrying(ServerStreamingCallable<RequestT,ResponseT> innerCallable, ServerStreamingCallSettings<RequestT,ResponseT> callSettings, ClientContext clientContext)
Parameters
Name Description
innerCallable ServerStreamingCallable<RequestT,ResponseT>
callSettings ServerStreamingCallSettings<RequestT,ResponseT>
clientContext ClientContext
Returns
Type Description
ServerStreamingCallable<RequestT,ResponseT>

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

public static UnaryCallable<RequestT,ResponseT> <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
Name Description
innerCallable UnaryCallable<RequestT,ResponseT>

the callable to issue calls

callSettings UnaryCallSettings<?,?>

UnaryCallSettings to configure the unary call-related settings with.

clientContext ClientContext

ClientContext to use to connect to the service.

Returns
Type Description
UnaryCallable<RequestT,ResponseT>

UnaryCallable callable object.

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

public static UnaryCallable<RequestT,ResponseT> <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
Name Description
innerCallable UnaryCallable<RequestT,ResponseT>

the callable to issue calls

callSettings UnaryCallSettings<?,?>

UnaryCallSettings to configure the unary call-related settings with.

clientContext ClientContext

ClientContext to use to connect to the service.

requestMutator RequestMutator

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

Returns
Type Description
UnaryCallable<RequestT,ResponseT>

UnaryCallable callable object.

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

public static ServerStreamingCallable<RequestT,ResponseT> <RequestT,ResponseT>watched(ServerStreamingCallable<RequestT,ResponseT> callable, ServerStreamingCallSettings<RequestT,ResponseT> callSettings, ClientContext clientContext)
Parameters
Name Description
callable ServerStreamingCallable<RequestT,ResponseT>
callSettings ServerStreamingCallSettings<RequestT,ResponseT>
clientContext ClientContext
Returns
Type Description
ServerStreamingCallable<RequestT,ResponseT>