HttpStandardResilienceOptions Class

Definition

Namespace:

Microsoft.Extensions.Http.Resilience

Assembly:

Microsoft.Extensions.Http.Resilience.dll

Package:

Microsoft.Extensions.Http.Resilience v9.0.0-preview.4.24271.2

Source:

HttpStandardResilienceOptions.cs

Options for resilience strategies for usage in HTTP scenarios.

public ref class HttpStandardResilienceOptions

public class HttpStandardResilienceOptions

type HttpStandardResilienceOptions = class

Public Class HttpStandardResilienceOptions

Inheritance

Object

HttpStandardResilienceOptions

Remarks

These options represent configuration for five chained resilience strategies in this order (from the outermost to the innermost):

Bulkhead -> Total Request Timeout -> Retry -> Circuit Breaker -> Attempt Timeout.

The configuration of each pipeline is initialized with the default options per type. The request goes through these strategies:

1. Total request timeout pipeline applies an overall timeout to the execution, ensuring that the request including hedging attempts, does not exceed the configured limit.
2. The retry pipeline retries the request in case the dependency is slow or returns a transient error.
3. The bulkhead pipeline limits the maximum number of concurrent requests being send to the dependency.
4. The circuit breaker blocks the execution if too many direct failures or timeouts are detected.
5. The attempt timeout pipeline limits each request attempt duration and throws if its exceeded.

Constructors

HttpStandardResilienceOptions()

Properties

AttemptTimeout	Gets or sets the options for the timeout pipeline applied per each request attempt.
CircuitBreaker	Gets or sets the circuit breaker options.
RateLimiter	Gets or sets the bulkhead options.
Retry	Gets or sets the retry pipeline options.
TotalRequestTimeout	Gets or sets the timeout Strategy options for the total timeout applied on the request's execution.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)