Language

HttpRetryStrategyOptions.RetryBudget Property

Definition

Gets or sets the retry budget options.

public:
 property Microsoft::Extensions::Http::Resilience::HttpRetryBudgetOptions ^ RetryBudget { Microsoft::Extensions::Http::Resilience::HttpRetryBudgetOptions ^ get(); void set(Microsoft::Extensions::Http::Resilience::HttpRetryBudgetOptions ^ value); };
[Microsoft.Extensions.Options.ValidateObjectMembers]
[System.Diagnostics.CodeAnalysis.Experimental("EXTEXP0001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public Microsoft.Extensions.Http.Resilience.HttpRetryBudgetOptions? RetryBudget { get; set; }
[Microsoft.Extensions.Options.ValidateObjectMembers]
public Microsoft.Extensions.Http.Resilience.HttpRetryBudgetOptions? RetryBudget { get; set; }
[<Microsoft.Extensions.Options.ValidateObjectMembers>]
[<System.Diagnostics.CodeAnalysis.Experimental("EXTEXP0001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
member this.RetryBudget : Microsoft.Extensions.Http.Resilience.HttpRetryBudgetOptions with get, set
[<Microsoft.Extensions.Options.ValidateObjectMembers>]
member this.RetryBudget : Microsoft.Extensions.Http.Resilience.HttpRetryBudgetOptions with get, set
Public Property RetryBudget As HttpRetryBudgetOptions

Property Value

The default value is null, which means retries are not limited by a budget.

Attributes

Remarks

The budget is applied by the standard resilience handler and by AddRetryWithBudget(ResiliencePipelineBuilder<HttpResponseMessage>, HttpRetryStrategyOptions). Polly.RetryResiliencePipelineBuilderExtensions.AddRetry``1(Polly.ResiliencePipelineBuilder{``0},Polly.Retry.RetryStrategyOptions{``0}) can't apply the budget, so it throws a ValidationException when the budget is set, instead of ignoring it. See HttpRetryBudgetOptions for more details.

Applies to