Skip to main content

Fields

int
required
How many times a read is tried.
string
required
The trace source of every vendor call.

Methods

Allows()

Whether the egress list allows a host.

Parameters

string
required
IReadOnlyDictionary<string, string>
required
The connection’s values, which fill the list’s templates.

Returns

bool

AsCreate()

Marks a request as creating an object, so a conflict means one already exists.

Parameters

HttpRequestMessage
required
The request.
string
required
The manifest object’s key.

Returns

HttpRequestMessage

AsObject()

Marks a request as addressing one object, so a not found means that object is gone.

Parameters

HttpRequestMessage
required
The request.
string
required
The manifest object’s key.
string
required
The vendor’s id for the object, or null when the caller names it on the failure.

Returns

HttpRequestMessage

AsRead()

Marks a request as a read.

Parameters

HttpRequestMessage
required

Returns

HttpRequestMessage

AuthHeadersAsync()

The headers the manifest’s auth puts on a request, for a connector in another process.

Parameters

required
required
IReadOnlyDictionary<string, string>
required
CancellationToken
required

Returns

Task<IReadOnlyDictionary<string, string>>

Context()

Builds a context for one connection.

Parameters

string
required
HttpMessageHandler
required
required
ILogger
required
required
IReadOnlyDictionary<string, string>
IReadOnlyDictionary<string, string>
Uri
Where to send the calls instead of the vendor. The installation’s base_url when not given.
TimeSpan?

Returns

ConnectionContext

Create()

Creates a client applying the manifest’s auth.

Parameters

HttpMessageHandler
required
required
required
IReadOnlyDictionary<string, string>

Returns

HttpClient
Creates a client sending bearer tokens.

Parameters

HttpMessageHandler
required
required

Returns

HttpClient

DefaultKind()

Gets the failure kind a status means.

Parameters

HttpStatusCode
required
bool
bool

Returns

FailureKind

IsRead()

Whether a request only reads.

Parameters

HttpRequestMessage
required

Returns

bool

ReadAsync()

Reads a response’s JSON body.

Type Parameters

required

Parameters

HttpResponseMessage
required
JsonSerializerOptions
required
CancellationToken
required

Returns

Task<T>

Transport()

Builds the pipeline without auth.

Parameters

HttpMessageHandler
required
Uri
TimeSpan?
IReadOnlyDictionary<string, string>
string
TimeSpan?
How long a call waits out a throttle before it fails as Throttled. Five seconds when not given.

Returns

HttpMessageHandler