Class EndpointFailure

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Bounded cause of a failed endpoint observation, including failures before any request reaches the endpoint. No field carries remote text: code and stage come from the domain's closed sets, provider and credential_key are configured names, and request_id is an opaque random ID.

public sealed class EndpointFailure : IMessage<EndpointFailure>, IEquatable<EndpointFailure>, IDeepCloneable<EndpointFailure>, IBufferMessage, IMessage

Inheritance

object

EndpointFailure

Implements

IMessage<EndpointFailure>

IEquatable<EndpointFailure>

IDeepCloneable<EndpointFailure>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

EndpointFailure()

public EndpointFailure()

EndpointFailure(EndpointFailure)

public EndpointFailure(EndpointFailure other)

Parameters

other EndpointFailure

Fields

CodeFieldNumber

Field number for the "code" field.

public const int CodeFieldNumber = 2

Field Value

int

CredentialKeyFieldNumber

Field number for the "credential_key" field.

public const int CredentialKeyFieldNumber = 5

Field Value

int

DomainFieldNumber

Field number for the "domain" field.

public const int DomainFieldNumber = 1

Field Value

int

ProviderFieldNumber

Field number for the "provider" field.

public const int ProviderFieldNumber = 4

Field Value

int

RecoveryActionFieldNumber

Field number for the "recovery_action" field.

public const int RecoveryActionFieldNumber = 3

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 8

Field Value

int

StageFieldNumber

Field number for the "stage" field.

public const int StageFieldNumber = 6

Field Value

int

UpstreamHttpStatusFieldNumber

Field number for the "upstream_http_status" field.

public const int UpstreamHttpStatusFieldNumber = 7

Field Value

int

Properties

Code

Stable lower_snake_case code from the domain's closed set, such as provider_authorization_required.

public string Code { get; set; }

Property Value

string

CredentialKey

Credential name within the provider. Never a credential value.

public string CredentialKey { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Domain

public EndpointFailureDomain Domain { get; set; }

Property Value

EndpointFailureDomain

HasUpstreamHttpStatus

Gets whether the "upstream_http_status" field is set

public bool HasUpstreamHttpStatus { get; }

Property Value

bool

Parser

public static MessageParser<EndpointFailure> Parser { get; }

Property Value

MessageParser<EndpointFailure>

Provider

Provider whose credential failed. Empty when the failure happened before a credential was selected.

public string Provider { get; set; }

Property Value

string

RecoveryAction

Who can resolve the failure; always the action documented for the code.

public ProviderCredentialRefreshRecoveryAction RecoveryAction { get; set; }

Property Value

ProviderCredentialRefreshRecoveryAction

RequestId

Supervisor-minted UUID of the refused exchange. The workload receives the same value in the x-openshell-request-id response header.

public string RequestId { get; set; }

Property Value

string

Stage

Step that observed the failure, from the domain's closed set.

public string Stage { get; set; }

Property Value

string

UpstreamHttpStatus

HTTP status a token service returned, when one was received.

public uint UpstreamHttpStatus { get; set; }

Property Value

uint

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

ClearUpstreamHttpStatus()

Clears the value of the "upstream_http_status" field

public void ClearUpstreamHttpStatus()

Clone()

Creates a deep clone of this object.

public EndpointFailure Clone()

Returns

EndpointFailure

A deep clone of this object.

Equals(EndpointFailure)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(EndpointFailure other)

Parameters

other EndpointFailure

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(EndpointFailure)

Merges the given message into this one.

public void MergeFrom(EndpointFailure other)

Parameters

other EndpointFailure

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.