Class Callables (2.55.0)

Beta

This library is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see thelaunch stage descriptions.

publicclassCallables

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)

publicstaticOperationCallable<RequestT,ResponseT,MetadataT><RequestT,ResponseT,MetadataT>longRunningOperation(UnaryCallable<RequestT,OperationSnapshot>initialCallable,OperationCallSettings<RequestT,ResponseT,MetadataT>operationCallSettings,ClientContextclientContext,LongRunningClientlongRunningClient)

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

Parameters
NameDescription
initialCallableUnaryCallable<RequestT,OperationSnapshot>

the callable that initiates the operation

operationCallSettingsOperationCallSettings<RequestT,ResponseT,MetadataT>

OperationCallSettings to configure the method-level settings with.

clientContextClientContext

ClientContext to use to connect to the service.

longRunningClientLongRunningClient

LongRunningClient to use to poll for updates on the Operation.

Returns
TypeDescription
OperationCallable<RequestT,ResponseT,MetadataT>

OperationCallable callable object.

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

publicstaticUnaryCallable<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
NameDescription
innerCallableUnaryCallable<RequestT,ResponseT>

the callable to issue calls

pagedCallSettingsPagedCallSettings<RequestT,ResponseT,PagedListResponseT>

PagedCallSettings to configure the paged settings with.

Returns
TypeDescription
UnaryCallable<RequestT,PagedListResponseT>

UnaryCallable callable object.

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

publicstaticUnaryCallable<RequestT,ResponseT><RequestT,ResponseT>batching(UnaryCallable<RequestT,ResponseT>innerCallable,BatchingCallSettings<RequestT,ResponseT>batchingCallSettings,ClientContextcontext)

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

Parameters
NameDescription
innerCallableUnaryCallable<RequestT,ResponseT>

the callable to issue calls

batchingCallSettingsBatchingCallSettings<RequestT,ResponseT>

BatchingSettings to configure the batching related settings with.

contextClientContext

ClientContext to use to connect to the service.

Returns
TypeDescription
UnaryCallable<RequestT,ResponseT>

UnaryCallable callable object.

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

publicstaticServerStreamingCallable<RequestT,ResponseT><RequestT,ResponseT>retrying(ServerStreamingCallable<RequestT,ResponseT>innerCallable,ServerStreamingCallSettings<RequestT,ResponseT>callSettings,ClientContextclientContext)
Parameters
NameDescription
innerCallableServerStreamingCallable<RequestT,ResponseT>
callSettingsServerStreamingCallSettings<RequestT,ResponseT>
clientContextClientContext
Returns
TypeDescription
ServerStreamingCallable<RequestT,ResponseT>

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

publicstaticUnaryCallable<RequestT,ResponseT><RequestT,ResponseT>retrying(UnaryCallable<RequestT,ResponseT>innerCallable,UnaryCallSettings<?,?>callSettings,ClientContextclientContext)

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

Parameters
NameDescription
innerCallableUnaryCallable<RequestT,ResponseT>

the callable to issue calls

callSettingsUnaryCallSettings<?,?>

UnaryCallSettings to configure the unary call-related settings with.

clientContextClientContext

ClientContext to use to connect to the service.

Returns
TypeDescription
UnaryCallable<RequestT,ResponseT>

UnaryCallable callable object.

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

publicstaticUnaryCallable<RequestT,ResponseT><RequestT,ResponseT>retrying(UnaryCallable<RequestT,ResponseT>innerCallable,UnaryCallSettings<?,?>callSettings,ClientContextclientContext,RequestMutatorrequestMutator)

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

Parameters
NameDescription
innerCallableUnaryCallable<RequestT,ResponseT>

the callable to issue calls

callSettingsUnaryCallSettings<?,?>

UnaryCallSettings to configure the unary call-related settings with.

clientContextClientContext

ClientContext to use to connect to the service.

requestMutatorRequestMutator

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

Returns
TypeDescription
UnaryCallable<RequestT,ResponseT>

UnaryCallable callable object.

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

publicstaticServerStreamingCallable<RequestT,ResponseT><RequestT,ResponseT>watched(ServerStreamingCallable<RequestT,ResponseT>callable,ServerStreamingCallSettings<RequestT,ResponseT>callSettings,ClientContextclientContext)
Parameters
NameDescription
callableServerStreamingCallable<RequestT,ResponseT>
callSettingsServerStreamingCallSettings<RequestT,ResponseT>
clientContextClientContext
Returns
TypeDescription
ServerStreamingCallable<RequestT,ResponseT>

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-17 UTC.