Interface BatchingDescriptor<RequestT,ResponseT> (2.17.0)

Version 2.17.0

• 2.57.0 (latest)
• 2.55.0
• 2.54.1
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.1
• 2.47.0
• 2.46.1
• 2.45.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.1
• 2.33.0
• 2.32.1
• 2.31.1
• 2.30.1
• 2.24.0
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.1
• 2.19.6
• 2.18.7
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.2
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.1
• 2.7.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.

Type Parameters

Name	Description
RequestT
ResponseT

Methods

countBytes(RequestT request)

public abstract long countBytes(RequestT request)

Returns the size in bytes of this request.

Parameter

Name	Description
request	RequestT

Returns

Type	Description
long

countElements(RequestT request)

public abstract long countElements(RequestT request)

Returns the number of elements contained in this request.

Parameter

Name	Description
request	RequestT

Returns

Type	Description
long

getBatchPartitionKey(RequestT request)

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

getRequestBuilder()

public abstract RequestBuilder<RequestT> getRequestBuilder()

Get the Builder object for the request type RequestT.

Returns

Type	Description
RequestBuilder<RequestT>

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

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>>

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

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>>