Class BatchRequest

public sealed class BatchRequest

A batch request which represents individual requests to Google servers. You should add a single service request using the Queue<TResponse>(IClientServiceRequest, BatchRequest.OnResponse<TResponse>) method and execute all individual requests using ExecuteAsync(). More information about the batch protocol is available in https://developers.google.com/storage/docs/json_api/v1/how-tos/batch.

Inheritance

Object > BatchRequest

Namespace

Google.Apis.Requests

Assembly

Google.Apis.dll

Constructors

BatchRequest(IClientService)

public BatchRequest(IClientService service)

Constructs a new batch request using the given service. See BatchRequest(IClientService, String) for more information.

Parameter
NameDescription
serviceIClientService

BatchRequest(IClientService, String)

public BatchRequest(IClientService service, string batchUrl)

Constructs a new batch request using the given service. The service's HTTP client is used to create a request to the given server URL and its serializer members are used to serialize the request and deserialize the response.

Parameters
NameDescription
serviceIClientService
batchUrlString

Properties

Count

public int Count { get; }

Gets the count of all queued requests.

Property Value
TypeDescription
Int32

Methods

ExecuteAsync()

public Task ExecuteAsync()

Asynchronously executes the batch request.

Returns
TypeDescription
Task

ExecuteAsync(CancellationToken)

public Task ExecuteAsync(CancellationToken cancellationToken)

Asynchronously executes the batch request.

Parameter
NameDescription
cancellationTokenCancellationToken

Cancellation token to cancel operation.

Returns
TypeDescription
Task

Queue<TResponse>(IClientServiceRequest, BatchRequest.OnResponse<TResponse>)

public void Queue<TResponse>(IClientServiceRequest request, BatchRequest.OnResponse<TResponse> callback)
    where TResponse : class

Queues an individual request.

Parameters
NameDescription
requestIClientServiceRequest

The individual request.

callbackBatchRequest.OnResponse<TResponse>

A callback which will be called after a response was parsed.

Type Parameter
NameDescription
TResponse

The response's type.

Extension Method