Interface IApizrRequestOptionsBuilder<TApizrOptions, TApizrOptionsBuilder>

Namespace

Apizr.Configuring.Request

Assembly

Apizr.dll

Builder options available at request level

public interface IApizrRequestOptionsBuilder<out TApizrOptions, out TApizrOptionsBuilder> : IApizrRequestOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>, IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>, IApizrRequestOptionsBuilderBase, IApizrGlobalSharedOptionsBuilderBase where TApizrOptions : IApizrRequestOptions where TApizrOptionsBuilder : IApizrRequestOptionsBuilder<out TApizrOptions, out TApizrOptionsBuilder>

Type Parameters

TApizrOptions

TApizrOptionsBuilder

Inherited Members

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithExCatching(Action<ApizrException>, bool, ApizrDuplicateStrategy)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithExCatching<TResult>(Action<ApizrException<TResult>>, bool, ApizrDuplicateStrategy)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithExCatching(Func<ApizrException, bool>, bool, ApizrDuplicateStrategy)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithExCatching<TResult>(Func<ApizrException<TResult>, bool>, bool, ApizrDuplicateStrategy)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithExCatching(Func<ApizrException, Task<bool>>, bool, ApizrDuplicateStrategy)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithExCatching<TResult>(Func<ApizrException<TResult>, Task<bool>>, bool, ApizrDuplicateStrategy)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithExCatching<THandler>(THandler, bool, ApizrDuplicateStrategy)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithHandlerParameter(string, object)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithResilienceProperty<TValue>(ResiliencePropertyKey<TValue>, TValue)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithLogging(HttpTracerMode, HttpMessageParts, params LogLevel[])

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithOperationTimeout(TimeSpan)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithRequestTimeout(TimeSpan)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithResilienceContextOptions(Action<IApizrResilienceContextOptionsBuilder>)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithLoggedHeadersRedactionNames(IEnumerable<string>, ApizrDuplicateStrategy)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithLoggedHeadersRedactionRule(Func<string, bool>, ApizrDuplicateStrategy)

IApizrGlobalSharedOptionsBuilderBase<TApizrOptions, TApizrOptionsBuilder>.WithCaching(CacheMode, TimeSpan?, bool)

Extension Methods

FileTransferOptionsBuilderExtensions.WithDynamicPath<T>(T, string)

FileTransferOptionsBuilderExtensions.WithProgress<TBuilder>(TBuilder)

FileTransferOptionsBuilderExtensions.WithProgress<TBuilder>(TBuilder, IApizrProgress)

FileTransferOptionsBuilderExtensions.WithProgress<TBuilder>(TBuilder, Action<ApizrProgressEventArgs>)

HttpMessagePartsExtensions.IgnoreMessageParts<T>(T, HttpMessageParts)

Methods

WithCacheClearing(bool)

Tells if you want to clear the potential cached data before requesting

TApizrOptionsBuilder WithCacheClearing(bool clearCache)

Parameters

clearCache bool

Clear cache or not

Returns

TApizrOptionsBuilder

WithCancellation(CancellationToken)

Set the cancellation token

TApizrOptionsBuilder WithCancellation(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token

Returns

TApizrOptionsBuilder

WithHeaders(IList<string>, ApizrDuplicateStrategy)

Add some headers to the request

TApizrOptionsBuilder WithHeaders(IList<string> headers, ApizrDuplicateStrategy strategy = ApizrDuplicateStrategy.Add)

Parameters

headers IList<string>

Headers to add to the request

strategy ApizrDuplicateStrategy

The duplicate strategy if there's any other already (default: Add)

Returns

TApizrOptionsBuilder

WithResiliencePipelineKeys(string[], ApizrDuplicateStrategy)

Apply some resilience strategies by getting pipelines from registry with key matching.

TApizrOptionsBuilder WithResiliencePipelineKeys(string[] resiliencePipelineKeys, ApizrDuplicateStrategy duplicateStrategy = ApizrDuplicateStrategy.Add)

Parameters

resiliencePipelineKeys string[]

Resilience pipeline keys from the registry.

duplicateStrategy ApizrDuplicateStrategy

The duplicate strategy if there's any other names already (default: Add)

Returns

TApizrOptionsBuilder