Class Batch<RequestT,ResponseT> (2.62.0)

  public 
  
 class 
 Batch<RequestT 
 , 
 ResponseT 
> 

A Batch contains a collection of requests that are to be batched into a single API call.

A Batch contains a single UnaryCallable object, which will be used to make the API call, and a list of BatchedRequestIssuer objects, which represent the individual requests in the batch.

Additional batches can be merged into an existing batch using the <xref uid="com.google.api.gax.rpc.Batch.merge(com.google.api.gax.rpc.Batch<RequestT,ResponseT>)" data-throw-if-not-resolved="false">#merge(Batch) method. Request objects are combined using a RequestBuilder into a single request.

This is public only for technical reasons, for advanced usage.

Inheritance

java.lang.Object > Batch<RequestT,ResponseT>

Type Parameters

Name
Description
RequestT
ResponseT

Constructors

Batch(BatchingDescriptor<RequestT,ResponseT> descriptor, RequestT request, UnaryCallable<RequestT,ResponseT> callable, BatchedFuture<ResponseT> batchedFuture)

  public 
  
 Batch 
 ( 
 BatchingDescriptor<RequestT 
 , 
 ResponseT 
>  
 descriptor 
 , 
  
 RequestT 
  
 request 
 , 
  
 UnaryCallable<RequestT 
 , 
 ResponseT 
>  
 callable 
 , 
  
 BatchedFuture<ResponseT> 
  
 batchedFuture 
 ) 
 
Parameters
Name
Description
descriptor
BatchingDescriptor < RequestT , ResponseT >
request
RequestT
callable
UnaryCallable < RequestT , ResponseT >
batchedFuture
BatchedFuture < ResponseT >

Methods

getByteCount()

  public 
  
 long 
  
 getByteCount 
 () 
 
Returns
Type
Description

getCallable()

  public 
  
 UnaryCallable<RequestT 
 , 
 ResponseT 
>  
 getCallable 
 () 
 
Returns
Type
Description
UnaryCallable < RequestT , ResponseT >

getRequest()

  public 
  
 RequestT 
  
 getRequest 
 () 
 
Returns
Type
Description
RequestT

getRequestIssuerList()

  public 
  
 List<BatchedRequestIssuer<ResponseT> 
>  
 getRequestIssuerList 
 () 
 
Returns
Type
Description
List < BatchedRequestIssuer < ResponseT >>

merge(Batch<RequestT,ResponseT> batch)

  public 
  
 void 
  
 merge 
 ( 
 Batch<RequestT 
 , 
 ResponseT 
>  
 batch 
 ) 
 

Merge the given batch into this batch.

Parameter
Name
Description
batch
Batch < RequestT , ResponseT >
Design a Mobile Site
View Site in Mobile | Classic
Share by: