Interface BatchingDescriptor<RequestT,ResponseT> (2.34.1)

public interface BatchingDescriptor<RequestT,ResponseT>

Interface which represents an object that transforms request/response data for the purposes of batching.

Implementations of BatchingDescriptor must guarantee that all methods are stateless and thread safe.

This class is designed to be used by generated code.

Methods

public abstract long countBytes(RequestT request)

Returns the size in bytes of this request.

Parameter
Name	Description
`request`	`RequestT`

Returns
Type	Description
`long`

public abstract long countElements(RequestT request)

Returns the number of elements contained in this request.

Parameter
Name	Description
`request`	`RequestT`

Returns
Type	Description
`long`

public abstract PartitionKey getBatchPartitionKey(RequestT request)

Returns the value of the partition key for the given request.

Parameter
Name	Description
`request`	`RequestT`

Returns
Type	Description
`PartitionKey`

public abstract RequestBuilder<RequestT> getRequestBuilder()

Get the Builder object for the request type RequestT.

Returns
Type	Description
`RequestBuilder<RequestT>`

public abstract void splitException(Throwable throwable, Collection<? extends BatchedRequestIssuer<ResponseT>> batch)

Splits the exception that resulted from a batched call into an individual setException call on each RequestIssuer.

Parameters
Name	Description
`throwable`	`Throwable`
`batch`	`Collection<? extends com.google.api.gax.rpc.BatchedRequestIssuer<ResponseT>>`

public abstract void splitResponse(ResponseT batchResponse, Collection<? extends BatchedRequestIssuer<ResponseT>> batch)

Splits the result from a batched call into an individual setResponse call on each RequestIssuer.

Parameters
Name	Description
`batchResponse`	`ResponseT`
`batch`	`Collection<? extends com.google.api.gax.rpc.BatchedRequestIssuer<ResponseT>>`