Class ApizrManagerOptions<TWebApi>

Namespace

Apizr.Configuring.Manager

Assembly

Apizr.dll

Options available for static registrations

public class ApizrManagerOptions<TWebApi> : IApizrManagerOptions<TWebApi>, IApizrManagerOptionsBase, IApizrCommonOptionsBase, IApizrProperOptionsBase, IApizrSharedRegistrationOptionsBase, IApizrGlobalSharedRegistrationOptionsBase, IApizrGlobalSharedOptionsBase

Type Parameters

TWebApi

Inheritance

object

ApizrManagerOptions<TWebApi>

Implements

IApizrManagerOptions<TWebApi>

IApizrManagerOptionsBase

IApizrCommonOptionsBase

IApizrProperOptionsBase

IApizrSharedRegistrationOptionsBase

IApizrGlobalSharedRegistrationOptionsBase

IApizrGlobalSharedOptionsBase

Derived

ApizrExtendedManagerOptions<TWebApi>

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

ApizrManagerOptions(IApizrManagerOptionsBase)

The options constructor

public ApizrManagerOptions(IApizrManagerOptionsBase apizrOptions)

Parameters

apizrOptions IApizrManagerOptionsBase

The base options

Fields

Options

The options

protected readonly IApizrManagerOptionsBase Options

Field Value

IApizrManagerOptionsBase

Properties

ApizrConfigurationSection

Configuration section for Apizr

public IConfigurationSection ApizrConfigurationSection { get; }

Property Value

IConfigurationSection

BaseAddress

Base address

public string BaseAddress { get; }

Property Value

string

BasePath

Base path

public string BasePath { get; }

Property Value

string

BaseUri

Base address

public Uri BaseUri { get; }

Property Value

Uri

CacheOptions

The caching options to apply

public IDictionary<ApizrConfigurationSource, CacheAttributeBase> CacheOptions { get; }

Property Value

IDictionary<ApizrConfigurationSource, CacheAttributeBase>

CrudApiEntityType

Crud api entity type if any

public Type CrudApiEntityType { get; }

Property Value

Type

ExceptionHandlers

Catching potential exception if defined

public IList<IApizrExceptionHandler> ExceptionHandlers { get; }

Property Value

IList<IApizrExceptionHandler>

HandlersParameters

Parameters passed through delegating handlers

public IDictionary<string, object> HandlersParameters { get; }

Property Value

IDictionary<string, object>

Headers

Headers to add to the request

public IDictionary<ApizrRegistrationMode, IList<string>> Headers { get; }

Property Value

IDictionary<ApizrRegistrationMode, IList<string>>

HeadersFactories

Headers factories

public IDictionary<(ApizrRegistrationMode Mode, ApizrLifetimeScope Scope), Func<IList<string>>> HeadersFactories { get; }

Property Value

IDictionary<(ApizrRegistrationMode Mode, ApizrLifetimeScope Scope), Func<IList<string>>>

HttpTracerMode

Http traffic tracing mode

public HttpTracerMode HttpTracerMode { get; }

Property Value

HttpTracerMode

IsCrudApi

True if it's a CRUD api

public bool IsCrudApi { get; }

Property Value

bool

LetThrowOnHandledException

Let throw potential exception even if it's handled (default: true)

public bool LetThrowOnHandledException { get; }

Property Value

bool

LogLevels

Log levels while writing

public LogLevel[] LogLevels { get; }

Property Value

LogLevel[]

Logger

The logger instance

public ILogger Logger { get; }

Property Value

ILogger

OperationTimeout

The operation timeout (overall request tries)

public TimeSpan? OperationTimeout { get; }

Property Value

TimeSpan?

PrimaryHandlerFactory

The primary Http message handler factory (set internally)

public Func<DelegatingHandler, ILogger, IApizrManagerOptionsBase, HttpMessageHandler> PrimaryHandlerFactory { get; }

Property Value

Func<DelegatingHandler, ILogger, IApizrManagerOptionsBase, HttpMessageHandler>

RefitSettings

Refit settings

public RefitSettings RefitSettings { get; }

Property Value

RefitSettings

RequestNames

Web api request names

public IReadOnlyList<string> RequestNames { get; }

Property Value

IReadOnlyList<string>

RequestOptionsBuilders

The request options builders

public IDictionary<string, Action<IApizrRequestOptionsBuilder>> RequestOptionsBuilders { get; }

Property Value

IDictionary<string, Action<IApizrRequestOptionsBuilder>>

RequestTimeout

The request timeout (each request try)

public TimeSpan? RequestTimeout { get; }

Property Value

TimeSpan?

ResiliencePipelineOptions

Resilience pipeline keys from the registry

public IDictionary<ApizrConfigurationSource, ResiliencePipelineAttributeBase[]> ResiliencePipelineOptions { get; }

Property Value

IDictionary<ApizrConfigurationSource, ResiliencePipelineAttributeBase[]>

ShouldRedactHeaderValue

The Func<T, TResult> which determines whether to redact the HTTP header value before logging.

public Func<string, bool> ShouldRedactHeaderValue { get; }

Property Value

Func<string, bool>

TrafficVerbosity

Http traffic tracing verbosity

public HttpMessageParts TrafficVerbosity { get; }

Property Value

HttpMessageParts

TypeInfo

Web api interface or Crud api entity class type info

public TypeInfo TypeInfo { get; }

Property Value

TypeInfo

WebApiType

Web api interface type

public Type WebApiType { get; }

Property Value

Type