Class Callables (2.87.0)

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

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)

Static Methods

longRunningOperation(UnaryCallable initialCallable, OperationCallSettings operationCallSettings, ClientContext clientContext, LongRunningClient longRunningClient)

public static OperationCallable,ResponseT,MetadataT> <RequestT,ResponseT,MetadataT>longRunningOperation(UnaryCallable,OperationSnapshot> initialCallable, OperationCallSettings,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.

paged(UnaryCallable innerCallable, PagedCallSettings pagedCallSettings)

public static UnaryCallable,PagedListResponseT> <RequestT,ResponseT,PagedListResponseT>paged(UnaryCallable,ResponseT> innerCallable, PagedCallSettings,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.

batching(UnaryCallable innerCallable, BatchingCallSettings batchingCallSettings, ClientContext context)

public static UnaryCallable,ResponseT> <RequestT,ResponseT>batching(UnaryCallable,ResponseT> innerCallable, BatchingCallSettings,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.

resumableUpload(ResumableUploadClient uploadClient, UnaryCallSettings callSettings, ClientContext clientContext)

public static ResumableUploadCallable,ResponseT> <RequestT,ResponseT>resumableUpload(ResumableUploadClient,ResponseT> uploadClient, UnaryCallSettings,ResponseT> callSettings, ClientContext clientContext)

Creates a ResumableUploadCallable to execute resumable uploads. Designed for use by generated code.

Parameters
Name	Description
`uploadClient`	`ResumableUploadClient<RequestT,ResponseT>` client executing the wire-level upload protocol
`callSettings`	`UnaryCallSettings<RequestT,ResponseT>` UnaryCallSettings to configure the method-level settings with
`clientContext`	`ClientContext` ClientContext to use to connect to the service.

Returns
Type	Description
`ResumableUploadCallable<RequestT,ResponseT>`	ResumableUploadCallable callable object

retrying(ServerStreamingCallable innerCallable, ServerStreamingCallSettings callSettings, ClientContext clientContext)

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

Parameters
Name	Description
`innerCallable`	`ServerStreamingCallable<RequestT,ResponseT>`
`callSettings`	`ServerStreamingCallSettings<RequestT,ResponseT>`
`clientContext`	`ClientContext`

Returns
Type	Description
`ServerStreamingCallable<RequestT,ResponseT>`

retrying(UnaryCallable innerCallable, UnaryCallSettings callSettings, ClientContext clientContext)

public static UnaryCallable,ResponseT> <RequestT,ResponseT>retrying(UnaryCallable,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.

retrying(UnaryCallable innerCallable, UnaryCallSettings callSettings, ClientContext clientContext, RequestMutator requestMutator)

public static UnaryCallable,ResponseT> <RequestT,ResponseT>retrying(UnaryCallable,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.

watched(ServerStreamingCallable callable, ServerStreamingCallSettings callSettings, ClientContext clientContext)

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

Parameters
Name	Description
`callable`	`ServerStreamingCallable<RequestT,ResponseT>`
`callSettings`	`ServerStreamingCallSettings<RequestT,ResponseT>`
`clientContext`	`ClientContext`

Returns
Type	Description
`ServerStreamingCallable<RequestT,ResponseT>`