Class PolicyBuilder<TResult>

Namespace

Polly

Assembly

Polly.dll

Builder class that holds the list of current execution predicates filtering TResult result values.

public sealed class PolicyBuilder<TResult>

Type Parameters

TResult

Inheritance

object

PolicyBuilder<TResult>

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AdvancedCircuitBreakerTResultSyntax.AdvancedCircuitBreaker<TResult>(PolicyBuilder<TResult>, double, TimeSpan, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan, Context>, Action<Context>, Action)

AdvancedCircuitBreakerTResultSyntax.AdvancedCircuitBreaker<TResult>(PolicyBuilder<TResult>, double, TimeSpan, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan, Context>, Action<Context>)

AdvancedCircuitBreakerTResultSyntax.AdvancedCircuitBreaker<TResult>(PolicyBuilder<TResult>, double, TimeSpan, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan>, Action, Action)

AdvancedCircuitBreakerTResultSyntax.AdvancedCircuitBreaker<TResult>(PolicyBuilder<TResult>, double, TimeSpan, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan>, Action)

AdvancedCircuitBreakerTResultSyntax.AdvancedCircuitBreaker<TResult>(PolicyBuilder<TResult>, double, TimeSpan, int, TimeSpan)

AdvancedCircuitBreakerTResultSyntaxAsync.AdvancedCircuitBreakerAsync<TResult>(PolicyBuilder<TResult>, double, TimeSpan, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan, Context>, Action<Context>, Action)

AdvancedCircuitBreakerTResultSyntaxAsync.AdvancedCircuitBreakerAsync<TResult>(PolicyBuilder<TResult>, double, TimeSpan, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan, Context>, Action<Context>)

AdvancedCircuitBreakerTResultSyntaxAsync.AdvancedCircuitBreakerAsync<TResult>(PolicyBuilder<TResult>, double, TimeSpan, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan>, Action, Action)

AdvancedCircuitBreakerTResultSyntaxAsync.AdvancedCircuitBreakerAsync<TResult>(PolicyBuilder<TResult>, double, TimeSpan, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan>, Action)

AdvancedCircuitBreakerTResultSyntaxAsync.AdvancedCircuitBreakerAsync<TResult>(PolicyBuilder<TResult>, double, TimeSpan, int, TimeSpan)

CircuitBreakerTResultSyntax.CircuitBreaker<TResult>(PolicyBuilder<TResult>, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan, Context>, Action<Context>, Action)

CircuitBreakerTResultSyntax.CircuitBreaker<TResult>(PolicyBuilder<TResult>, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan, Context>, Action<Context>)

CircuitBreakerTResultSyntax.CircuitBreaker<TResult>(PolicyBuilder<TResult>, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan>, Action, Action)

CircuitBreakerTResultSyntax.CircuitBreaker<TResult>(PolicyBuilder<TResult>, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan>, Action)

CircuitBreakerTResultSyntax.CircuitBreaker<TResult>(PolicyBuilder<TResult>, int, TimeSpan)

CircuitBreakerTResultSyntaxAsync.CircuitBreakerAsync<TResult>(PolicyBuilder<TResult>, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan, Context>, Action<Context>, Action)

CircuitBreakerTResultSyntaxAsync.CircuitBreakerAsync<TResult>(PolicyBuilder<TResult>, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan, Context>, Action<Context>)

CircuitBreakerTResultSyntaxAsync.CircuitBreakerAsync<TResult>(PolicyBuilder<TResult>, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan>, Action, Action)

CircuitBreakerTResultSyntaxAsync.CircuitBreakerAsync<TResult>(PolicyBuilder<TResult>, int, TimeSpan, Action<DelegateResult<TResult>, TimeSpan>, Action)

CircuitBreakerTResultSyntaxAsync.CircuitBreakerAsync<TResult>(PolicyBuilder<TResult>, int, TimeSpan)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, TResult, Action<DelegateResult<TResult>, Context>)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, TResult, Action<DelegateResult<TResult>>)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, TResult)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, Func<TResult>, Action<DelegateResult<TResult>, Context>)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, Func<TResult>, Action<DelegateResult<TResult>>)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, Func<TResult>)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, Func<Context, TResult>, Action<DelegateResult<TResult>, Context>)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, Func<Context, CancellationToken, TResult>, Action<DelegateResult<TResult>, Context>)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, Func<DelegateResult<TResult>, Context, CancellationToken, TResult>, Action<DelegateResult<TResult>, Context>)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, Func<CancellationToken, TResult>, Action<DelegateResult<TResult>, Context>)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, Func<CancellationToken, TResult>, Action<DelegateResult<TResult>>)

FallbackTResultSyntax.Fallback<TResult>(PolicyBuilder<TResult>, Func<CancellationToken, TResult>)

FallbackTResultSyntaxAsync.FallbackAsync<TResult>(PolicyBuilder<TResult>, TResult, Func<DelegateResult<TResult>, Context, Task>)

FallbackTResultSyntaxAsync.FallbackAsync<TResult>(PolicyBuilder<TResult>, TResult, Func<DelegateResult<TResult>, Task>)

FallbackTResultSyntaxAsync.FallbackAsync<TResult>(PolicyBuilder<TResult>, TResult)

FallbackTResultSyntaxAsync.FallbackAsync<TResult>(PolicyBuilder<TResult>, Func<Context, CancellationToken, Task<TResult>>, Func<DelegateResult<TResult>, Context, Task>)

FallbackTResultSyntaxAsync.FallbackAsync<TResult>(PolicyBuilder<TResult>, Func<DelegateResult<TResult>, Context, CancellationToken, Task<TResult>>, Func<DelegateResult<TResult>, Context, Task>)

FallbackTResultSyntaxAsync.FallbackAsync<TResult>(PolicyBuilder<TResult>, Func<CancellationToken, Task<TResult>>, Func<DelegateResult<TResult>, Context, Task>)

FallbackTResultSyntaxAsync.FallbackAsync<TResult>(PolicyBuilder<TResult>, Func<CancellationToken, Task<TResult>>, Func<DelegateResult<TResult>, Task>)

FallbackTResultSyntaxAsync.FallbackAsync<TResult>(PolicyBuilder<TResult>, Func<CancellationToken, Task<TResult>>)

RetryTResultSyntax.Retry<TResult>(PolicyBuilder<TResult>)

RetryTResultSyntax.Retry<TResult>(PolicyBuilder<TResult>, Action<DelegateResult<TResult>, int, Context>)

RetryTResultSyntax.Retry<TResult>(PolicyBuilder<TResult>, Action<DelegateResult<TResult>, int>)

RetryTResultSyntax.Retry<TResult>(PolicyBuilder<TResult>, int, Action<DelegateResult<TResult>, int, Context>)

RetryTResultSyntax.Retry<TResult>(PolicyBuilder<TResult>, int, Action<DelegateResult<TResult>, int>)

RetryTResultSyntax.Retry<TResult>(PolicyBuilder<TResult>, int)

RetryTResultSyntax.RetryForever<TResult>(PolicyBuilder<TResult>)

RetryTResultSyntax.RetryForever<TResult>(PolicyBuilder<TResult>, Action<DelegateResult<TResult>, Context>)

RetryTResultSyntax.RetryForever<TResult>(PolicyBuilder<TResult>, Action<DelegateResult<TResult>>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, Context>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, int, Context>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>, Action<DelegateResult<TResult>, TimeSpan>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, int, Func<int, Context, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, Context>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, int, Func<int, Context, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, int, Context>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, int, Func<int, Context, TimeSpan>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, Context>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, int, Context>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan>)

RetryTResultSyntax.WaitAndRetry<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>)

RetryTResultSyntax.WaitAndRetryForever<TResult>(PolicyBuilder<TResult>, Func<int, Context, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, Context>)

RetryTResultSyntax.WaitAndRetryForever<TResult>(PolicyBuilder<TResult>, Func<int, Context, TimeSpan>)

RetryTResultSyntax.WaitAndRetryForever<TResult>(PolicyBuilder<TResult>, Func<int, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan>)

RetryTResultSyntax.WaitAndRetryForever<TResult>(PolicyBuilder<TResult>, Func<int, TimeSpan>)

RetryTResultSyntaxAsync.RetryAsync<TResult>(PolicyBuilder<TResult>)

RetryTResultSyntaxAsync.RetryAsync<TResult>(PolicyBuilder<TResult>, Action<DelegateResult<TResult>, int, Context>)

RetryTResultSyntaxAsync.RetryAsync<TResult>(PolicyBuilder<TResult>, Action<DelegateResult<TResult>, int>)

RetryTResultSyntaxAsync.RetryAsync<TResult>(PolicyBuilder<TResult>, Func<DelegateResult<TResult>, int, Context, Task>)

RetryTResultSyntaxAsync.RetryAsync<TResult>(PolicyBuilder<TResult>, Func<DelegateResult<TResult>, int, Task>)

RetryTResultSyntaxAsync.RetryAsync<TResult>(PolicyBuilder<TResult>, int, Action<DelegateResult<TResult>, int, Context>)

RetryTResultSyntaxAsync.RetryAsync<TResult>(PolicyBuilder<TResult>, int, Action<DelegateResult<TResult>, int>)

RetryTResultSyntaxAsync.RetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<DelegateResult<TResult>, int, Context, Task>)

RetryTResultSyntaxAsync.RetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<DelegateResult<TResult>, int, Task>)

RetryTResultSyntaxAsync.RetryAsync<TResult>(PolicyBuilder<TResult>, int)

RetryTResultSyntaxAsync.RetryForeverAsync<TResult>(PolicyBuilder<TResult>)

RetryTResultSyntaxAsync.RetryForeverAsync<TResult>(PolicyBuilder<TResult>, Action<DelegateResult<TResult>, Context>)

RetryTResultSyntaxAsync.RetryForeverAsync<TResult>(PolicyBuilder<TResult>, Action<DelegateResult<TResult>>)

RetryTResultSyntaxAsync.RetryForeverAsync<TResult>(PolicyBuilder<TResult>, Func<DelegateResult<TResult>, Context, Task>)

RetryTResultSyntaxAsync.RetryForeverAsync<TResult>(PolicyBuilder<TResult>, Func<DelegateResult<TResult>, Task>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, Context>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, int, Context>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>, Action<DelegateResult<TResult>, TimeSpan>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>, Func<DelegateResult<TResult>, TimeSpan, Context, Task>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>, Func<DelegateResult<TResult>, TimeSpan, int, Context, Task>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>, Func<DelegateResult<TResult>, TimeSpan, Task>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, IEnumerable<TimeSpan>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, Context, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, Context>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, Context, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, int, Context>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, Context, TimeSpan>, Func<DelegateResult<TResult>, TimeSpan, Context, Task>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, Context, TimeSpan>, Func<DelegateResult<TResult>, TimeSpan, int, Context, Task>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, Context>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, int, Context>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>, Func<DelegateResult<TResult>, TimeSpan, Context, Task>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>, Func<DelegateResult<TResult>, TimeSpan, int, Context, Task>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>, Func<DelegateResult<TResult>, TimeSpan, Task>)

RetryTResultSyntaxAsync.WaitAndRetryAsync<TResult>(PolicyBuilder<TResult>, int, Func<int, TimeSpan>)

RetryTResultSyntaxAsync.WaitAndRetryForeverAsync<TResult>(PolicyBuilder<TResult>, Func<int, Context, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan, Context>)

RetryTResultSyntaxAsync.WaitAndRetryForeverAsync<TResult>(PolicyBuilder<TResult>, Func<int, Context, TimeSpan>, Func<DelegateResult<TResult>, TimeSpan, Context, Task>)

RetryTResultSyntaxAsync.WaitAndRetryForeverAsync<TResult>(PolicyBuilder<TResult>, Func<int, Context, TimeSpan>)

RetryTResultSyntaxAsync.WaitAndRetryForeverAsync<TResult>(PolicyBuilder<TResult>, Func<int, TimeSpan>, Action<DelegateResult<TResult>, TimeSpan>)

RetryTResultSyntaxAsync.WaitAndRetryForeverAsync<TResult>(PolicyBuilder<TResult>, Func<int, TimeSpan>, Func<DelegateResult<TResult>, TimeSpan, Task>)

RetryTResultSyntaxAsync.WaitAndRetryForeverAsync<TResult>(PolicyBuilder<TResult>, Func<int, TimeSpan>)

Methods

OrResult(Func<TResult, bool>)

Specifies the type of result that this policy can handle with additional filters on the result.

public PolicyBuilder<TResult> OrResult(Func<TResult, bool> resultPredicate)

Parameters

resultPredicate Func<TResult, bool>

The predicate to filter the results this policy will handle.

Returns

PolicyBuilder<TResult>

The PolicyBuilder instance.

OrResult(TResult)

Specifies a result value which the policy will handle.

public PolicyBuilder<TResult> OrResult(TResult result)

Parameters

result TResult

The TResult value this policy will handle.

Returns

PolicyBuilder<TResult>

The PolicyBuilder instance.

Remarks

This policy filter matches the result value returned using .Equals(), ideally suited for value types such as int and enum. To match characteristics of class return types, consider the overload taking a result predicate.

Or<TException>()

Specifies the type of exception that this policy can handle.

public PolicyBuilder<TResult> Or<TException>() where TException : Exception

Returns

PolicyBuilder<TResult>

The PolicyBuilder instance.

Type Parameters

TException

The type of the exception to handle.

Or<TException>(Func<TException, bool>)

Specifies the type of exception that this policy can handle with additional filters on this exception type.

public PolicyBuilder<TResult> Or<TException>(Func<TException, bool> exceptionPredicate) where TException : Exception

Parameters

exceptionPredicate Func<TException, bool>

The exception predicate to filter the type of exception this policy can handle.

Returns

PolicyBuilder<TResult>

The PolicyBuilder instance.

Type Parameters

TException

The type of the exception.