Class OpenShellException

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

The error type thrown by every SDK operation.

public class OpenShellException : Exception, ISerializable

Inheritance

object

Exception

OpenShellException

Implements

ISerializable

Derived

OidcException

Inherited Members

Exception.GetBaseException()

Exception.GetType()

Exception.ToString()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

Exception.SerializeObjectState

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

OpenShellException(OpenShellErrorKind, string, Exception?)

Creates an exception of the given kind.

public OpenShellException(OpenShellErrorKind kind, string message, Exception? innerException = null)

Parameters

kind OpenShellErrorKind

message string

innerException Exception

Properties

ErrorInfo

The server-provided reason, domain, and metadata, when the gateway sent them.

public ErrorInfo? ErrorInfo { get; }

Property Value

ErrorInfo

FieldViolations

The request fields the gateway rejected; empty when it sent none.

public IReadOnlyList<FieldViolation> FieldViolations { get; }

Property Value

IReadOnlyList<FieldViolation>

GrpcStatusCode

The underlying gRPC status, when the error came from the gateway.

public StatusCode? GrpcStatusCode { get; }

Property Value

StatusCode?

IsAlreadyExists

True for AlreadyExists.

public bool IsAlreadyExists { get; }

Property Value

bool

IsConflict

True for Conflict.

public bool IsConflict { get; }

Property Value

bool

IsNotFound

True for NotFound.

public bool IsNotFound { get; }

Property Value

bool

IsTransient

True for errors that may succeed on retry.

public bool IsTransient { get; }

Property Value

bool

Kind

The error classification.

public OpenShellErrorKind Kind { get; }

Property Value

OpenShellErrorKind

RetryDelay

The delay the gateway suggested before trying again. It says nothing about whether repeating a mutation is safe; use a request id for that.

public TimeSpan? RetryDelay { get; }

Property Value

TimeSpan?