Class BatchingCallSettings<ElementT,ElementResultT,RequestT,ResponseT> (2.13.0)

public final class BatchingCallSettings<ElementT,ElementResultT,RequestT,ResponseT> extends UnaryCallSettings<RequestT,ResponseT>

This is an extension of UnaryCallSettings class to configure a UnaryCallable for calls to an API method that supports batching. The batching settings are provided using the instance of BatchingSettings.

Retry configuration will be applied on each batching RPC request.

Sample settings configuration:


 BatchingCallSettings batchingCallSettings = // Default BatchingCallSettings from the client
 BatchingCallSettings customBatchingCallSettings =
     batchingCallSettings
         .toBuilder()
         .setRetryableCodes(StatusCode.Code.UNAVAILABLE, ...)
         .setRetrySettings(RetrySettings.newBuilder()...build())
         .setBatchingSettings(BatchingSettings.newBuilder()...build())
         .build();
 

Inheritance

java.lang.Object > UnaryCallSettings > BatchingCallSettings<ElementT,ElementResultT,RequestT,ResponseT>

Type Parameters

NameDescription
ElementT
ElementResultT
RequestT
ResponseT

Static Methods

<ElementT,ElementResultT,RequestT,ResponseT>newBuilder(BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT> batchingDescriptor)

public static BatchingCallSettings.Builder<ElementT,ElementResultT,RequestT,ResponseT> <ElementT,ElementResultT,RequestT,ResponseT>newBuilder(BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT> batchingDescriptor)

Please use #toBuilder() to override settings values.

Parameter
NameDescription
batchingDescriptorBatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT>
Returns
TypeDescription
Builder<ElementT,ElementResultT,RequestT,ResponseT>

Methods

getBatchingDescriptor()

public BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT> getBatchingDescriptor()
Returns
TypeDescription
BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT>

getBatchingSettings()

public BatchingSettings getBatchingSettings()

Returns batching settings which contains multiple batch threshold levels.

Returns
TypeDescription
BatchingSettings

toBuilder()

public final BatchingCallSettings.Builder<ElementT,ElementResultT,RequestT,ResponseT> toBuilder()

Get a builder with the same values as this object. See the class documentation of BatchingCallSettings for a sample settings configuration.

Returns
TypeDescription
Builder<ElementT,ElementResultT,RequestT,ResponseT>
Overrides

toString()

public String toString()
Returns
TypeDescription
String
Overrides