BatchRequest<TBody,TOptions,TResponse> Class

Definition

Represents the information required to make a particular call with a request body of type TBody to the Batch service REST API.

public class BatchRequest<TBody,TOptions,TResponse> : Microsoft.Azure.Batch.Protocol.BatchRequestBase<TOptions,TResponse> where TOptions : IOptions, new() where TResponse : IAzureOperationResponse
type BatchRequest<'Body, 'Options, 'Response (requires 'Options :> IOptions and 'Options : (new : unit -> 'Options) and 'Response :> IAzureOperationResponse)> = class
    inherit BatchRequestBase<'Options, 'Response (requires 'Options :> IOptions and 'Options : (new : unit -> 'Options) and 'Response :> IAzureOperationResponse)>
Public Class BatchRequest(Of TBody, TOptions, TResponse)
Inherits BatchRequestBase(Of TOptions, TResponse)

Type Parameters

TBody

The type of the body parameters associated with the request.

TOptions

The type of the parameters passed outside the request body associated with the request.

TResponse

The response type expected from the request.

Inheritance
System.Object
BatchRequest<TBody,TOptions,TResponse>
Derived

Constructors

BatchRequest<TBody,TOptions,TResponse>(BatchServiceClient, TBody, CancellationToken)

Initializes a new instance of the BatchRequest<TBody,TOptions,TResponse> class.

Properties

CancellationToken

Gets or sets the CancellationToken associated with this IBatchRequest.

(Inherited from BatchRequestBase<TOptions,TResponse>)
ClientRequestIdProvider

Gets or sets the ClientRequestIdProvider used by this request to generate client request ids.

(Inherited from BatchRequestBase<TOptions,TResponse>)
CustomHeaders

Gets the headers used for the request.

(Inherited from BatchRequestBase<TOptions,TResponse>)
OperationContext

Gets the operation context associated with this IBatchRequest.

(Inherited from BatchRequestBase<TOptions,TResponse>)
Options

Gets or sets the options used for the request.

(Inherited from BatchRequestBase<TOptions,TResponse>)
Parameters

Gets or sets the parameters passed in the REST API request body.

RestClient

Gets the REST client that will be used for this request.

(Inherited from BatchRequestBase<TOptions,TResponse>)
RetryPolicy

Gets or sets the retry policy to be applied. Null means no retries will be attempted.

(Inherited from BatchRequestBase<TOptions,TResponse>)
ServiceRequestFunc

Gets or sets the function which will create a System.Threading.Tasks.Task calling the Batch service.

(Inherited from BatchRequestBase<TOptions,TResponse>)
Timeout

Gets or sets the client side timeout for a request to the Batch service.

(Inherited from BatchRequestBase<TOptions,TResponse>)

Methods

ExecuteRequestAsync()

Executes the request.

(Inherited from BatchRequestBase<TOptions,TResponse>)
ThrowIfRequestExecutionHasStarted()

Throws an exception if request execution has started.

(Inherited from BatchRequestBase<TOptions,TResponse>)

Explicit Interface Implementations

IBatchRequest.Options

Gets the options needed by the REST proxy for the current request.

(Inherited from BatchRequestBase<TOptions,TResponse>)

Applies to