BatchRequestBase<TOptions,TResponse> Class

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: BatchRequest.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A base class for all Batch service requests. Represents the information required to make a particular call with no request body to the Batch service REST API.

public abstract class BatchRequestBase<TOptions,TResponse> : Microsoft.Azure.Batch.Protocol.IBatchRequest<TResponse> where TOptions : IOptions, new() where TResponse : IAzureOperationResponse

type BatchRequestBase<'Options, 'Response (requires 'Options :> IOptions and 'Options : (new : unit -> 'Options) and 'Response :> IAzureOperationResponse)> = class
    interface IBatchRequest<'Response (requires 'Response :> IAzureOperationResponse)>
    interface IBatchRequest

Public MustInherit Class BatchRequestBase(Of TOptions, TResponse)
Implements IBatchRequest(Of TResponse)

Type Parameters

TOptions

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

TResponse

The response type expected from the request.

Inheritance: Object
BatchRequestBase<TOptions,TResponse>

Derived: Microsoft.Azure.Batch.Protocol.BatchRequest<TOptions,TResponse>

Microsoft.Azure.Batch.Protocol.BatchRequest<TBody,TOptions,TResponse>

Implements: IBatchRequest IBatchRequest<TResponse>

Constructors

BatchRequestBase<TOptions,TResponse>(BatchServiceClient, CancellationToken)

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

Properties

CancellationToken	Gets or sets the CancellationToken associated with this IBatchRequest.
ClientRequestIdProvider	Gets or sets the ClientRequestIdProvider used by this request to generate client request ids.
CustomHeaders	Gets the headers used for the request.
OperationContext	Gets the operation context associated with this IBatchRequest.
Options	Gets or sets the options used for the request.
RestClient	Gets the REST client that will be used for this request.
RetryPolicy	Gets or sets the retry policy to be applied. Null means no retries will be attempted.
ServiceRequestFunc	Gets or sets the function which will create a Task calling the Batch service.
Timeout	Gets or sets the client side timeout for a request to the Batch service.

Methods

ExecuteRequestAsync()	Executes the request.
ThrowIfRequestExecutionHasStarted()	Throws an exception if request execution has started.

Explicit Interface Implementations

IBatchRequest.Options

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

Applies to