Class EndpointFailure

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

A classified cause of an endpoint failure, such as a token grant that could not be completed.

public sealed record EndpointFailure : IEquatable<EndpointFailure>

Inheritance

object

EndpointFailure

Implements

IEquatable<EndpointFailure>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Code

A stable lower_snake_case cause within the domain, for example provider_authorization_required.

public string Code { get; init; }

Property Value

string

CredentialKey

The credential key within the provider, when known.

public string CredentialKey { get; init; }

Property Value

string

Domain

The classifying subsystem.

public EndpointFailureDomain Domain { get; init; }

Property Value

EndpointFailureDomain

Provider

The provider whose credential was involved, when known.

public string Provider { get; init; }

Property Value

string

RecoveryAction

What an operator should do about it.

public RefreshRecoveryAction RecoveryAction { get; init; }

Property Value

RefreshRecoveryAction

RequestId

The x-openshell-request-id the workload saw on the failed request, for correlation.

public string RequestId { get; init; }

Property Value

string

Stage

A stable lower_snake_case stage where it failed, for example gateway_rpc.

public string Stage { get; init; }

Property Value

string

UpstreamHttpStatus

The HTTP status the upstream returned, when one was received.

public uint? UpstreamHttpStatus { get; init; }

Property Value

uint?