Interface BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT> (2.12.2)

public interface BatchingDescriptor<ElementT,ElementResultT,RequestT,ResponseT>

An adapter that packs and unpacks the elements in and out of batch requests and responses.

This interface should be implemented by either a service specific client or autogenerated by gapic-generator.

Example implementation:


 class ListDescriptor implements BatchingDescriptor

Type Parameters

public abstract long countBytes(ElementT element)

Returns the size of the passed element object in bytes.

Parameter

Name	Description
element	`ElementT`

Returns

Type	Description
long

public abstract BatchingRequestBuilder<ElementT,RequestT> newRequestBuilder(RequestT prototype)

Creates a new wrapper for the underlying request builder. It's used to pack the current batch request with elements.

Parameter

Name	Description
prototype	`RequestT`

Returns

Type	Description
BatchingRequestBuilder<ElementT,RequestT>

public abstract void splitException(Throwable throwable, List<BatchEntry<ElementT,ElementResultT>> batch)

Unpacks the batch response error into individual element errors.

Parameters

Name	Description
throwable	`Throwable`
batch	`List<BatchEntry<ElementT,ElementResultT>>`

public abstract void splitResponse(ResponseT batchResponse, List<BatchEntry<ElementT,ElementResultT>> batch)

Unpacks the batch response into individual elements results.

Parameters

Name	Description
batchResponse	`ResponseT`
batch	`List<BatchEntry<ElementT,ElementResultT>>`