HttpErrorModule

PackageAxial.HttpClient
A recoverable HTTP transport, timeout, status, or decoding failure.

Summary

NameSignatureSynopsis
Union cases
IsInvalidRequestthis.IsInvalidRequestNo description available.
IsCanceledthis.IsCanceledNo description available.
IsDecodeFailedthis.IsDecodeFailedNo description available.
IsStatusthis.IsStatusNo description available.
IsTimedOutthis.IsTimedOutNo description available.
IsConnectionFailedthis.IsConnectionFailedNo description available.
InvalidRequestInvalidRequest messageThe request could not be constructed, for example from a malformed URL.
ConnectionFailedConnectionFailed(request, message)The connection could not be established or was dropped before a response arrived.
TimedOutTimedOut(request, timeout)The per-request timeout elapsed before the response completed.
CanceledCanceled messageThe workflow was canceled while the request was in flight.
StatusStatus responseThe response arrived with a status outside the request's expectation.
DecodeFailedDecodeFailed(message, response)The response body could not be decoded into the requested value.
Operations
describeHttpError.describe _arg1Formats an HTTP error with its redacted request context.
tryResponseHttpError.tryResponse _arg1Returns the response transcript when the error carries one.
isTransientHttpError.isTransient _arg1Indicates whether retrying the same request could plausibly succeed.
transientPolicyHttpError.transientPolicy maxAttempts baseDelayBuilds a retry policy with exponential backoff that retries only transient HTTP errors.

Union cases

kind:member

IsInvalidRequest

this.IsInvalidRequest
Member

Returns

bool
kind:member

IsCanceled

this.IsCanceled
Member

Returns

bool
kind:member

IsDecodeFailed

this.IsDecodeFailed
Member

Returns

bool
kind:member

IsStatus

this.IsStatus
Member

Returns

bool
kind:member

IsTimedOut

this.IsTimedOut
Member

Returns

bool
kind:member

IsConnectionFailed

this.IsConnectionFailed
Member

Returns

bool
kind:member

InvalidRequest

InvalidRequest message
Member
The request could not be constructed, for example from a malformed URL.

Parameters

NameTypeDescription
messagestring

Returns

unit
kind:member

ConnectionFailed

ConnectionFailed(request, message)
Member
The connection could not be established or was dropped before a response arrived.

Parameters

NameTypeDescription
requeststring
messagestring

Returns

unit
kind:member

TimedOut

TimedOut(request, timeout)
Member
The per-request timeout elapsed before the response completed.

Parameters

NameTypeDescription
requeststring
timeoutTimeSpan

Returns

unit
kind:member

Canceled

Canceled message
Member
The workflow was canceled while the request was in flight.

Parameters

NameTypeDescription
messagestring

Returns

unit
kind:member

Status

Status response
Member
The response arrived with a status outside the request's expectation.

Parameters

NameTypeDescription
responseHttpResponse

Returns

unit
kind:member

DecodeFailed

DecodeFailed(message, response)
Member
The response body could not be decoded into the requested value.

Parameters

NameTypeDescription
messagestring
responseHttpResponse

Returns

unit

Operations

kind:member

describe

HttpError.describe _arg1
Member
Formats an HTTP error with its redacted request context. <example><code>error |&gt; HttpError.describe</code></example>

Parameters

NameTypeDescription
_arg1HttpError

Returns

string
kind:member

tryResponse

HttpError.tryResponse _arg1
Member
Returns the response transcript when the error carries one. <example><code>HttpError.tryResponse error</code></example>

Parameters

NameTypeDescription
_arg1HttpError

Returns

HttpResponse option
kind:member

isTransient

HttpError.isTransient _arg1
Member
Indicates whether retrying the same request could plausibly succeed. Connection failures, timeouts, and 408/429/5xx statuses are transient. <example><code>if HttpError.isTransient error then retry ()</code></example>

Parameters

NameTypeDescription
_arg1HttpError

Returns

bool
kind:member

transientPolicy

HttpError.transientPolicy maxAttempts baseDelay
Member
Builds a retry policy with exponential backoff that retries only transient HTTP errors. <example><code>workflow |&gt; Flow.Runtime.retry (HttpError.transientPolicy 4 (TimeSpan.FromMilliseconds 200.0))</code></example>

Parameters

NameTypeDescription
maxAttemptsint
baseDelayTimeSpan

Returns

RetryPolicy<HttpError>