errors

Documentation

Index

• Variables
• type StatelyErrorDetails
  • func (m *StatelyErrorDetails) CloneMessageVT() proto.Message
  • func (m *StatelyErrorDetails) CloneVT() *StatelyErrorDetails
  • func (*StatelyErrorDetails) Descriptor() ([]byte, []int)
  • func (this *StatelyErrorDetails) EqualMessageVT(thatMsg proto.Message) bool
  • func (this *StatelyErrorDetails) EqualVT(that *StatelyErrorDetails) bool
  • func (x *StatelyErrorDetails) GetCode() uint32
  • func (x *StatelyErrorDetails) GetMessage() string
  • func (x *StatelyErrorDetails) GetStatelyCode() string
  • func (x *StatelyErrorDetails) GetUpstreamCause() string
  • func (m *StatelyErrorDetails) MarshalToSizedBufferVT(dAtA []byte) (int, error)
  • func (m *StatelyErrorDetails) MarshalToVT(dAtA []byte) (int, error)
  • func (m *StatelyErrorDetails) MarshalVT() (dAtA []byte, err error)
  • func (*StatelyErrorDetails) ProtoMessage()
  • func (x *StatelyErrorDetails) ProtoReflect() protoreflect.Message
  • func (x *StatelyErrorDetails) Reset()
  • func (m *StatelyErrorDetails) SizeVT() (n int)
  • func (x *StatelyErrorDetails) String() string
  • func (m *StatelyErrorDetails) UnmarshalVT(dAtA []byte) error

Variables

var File_errors_error_details_proto protoreflect.FileDescriptor

Types

type StatelyErrorDetails

type StatelyErrorDetails struct {

	// stately_code is the error code that was returned by the Stately API.
	// The full list of codes is available at https://docs.stately.cloud/api/error-codes/
	// and documentation on a specific code can be found at https://docs.stately.cloud/api/error-codes/#{stately_code}
	StatelyCode string `protobuf:"bytes,1,opt,name=stately_code,json=statelyCode,proto3" json:"stately_code,omitempty"`
	// message is a human-readable error message that can be displayed to the user that
	// provides more context about the error.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// upstream_cause is additional information about the error that can be used to help debug the error,
	// This field will only optionally be supplied by the Stately API.
	// Note: This may row over as the error is passed through multiple services.
	UpstreamCause string `protobuf:"bytes,3,opt,name=upstream_cause,json=upstreamCause,proto3" json:"upstream_cause,omitempty"`
	// The Connect/gRPC code associated with this error. This generally isn't set,
	// because the overall API response has an error code. But this can be used in
	// the case that we're returning multiple different errors, or communicating
	// errors across non-Connect APIs.
	Code uint32 `protobuf:"varint,4,opt,name=code,proto3" json:"code,omitempty"`
	// contains filtered or unexported fields
}

StatelyErrorDetails is a message containing detailed error information. This is returned from the Stately API via Connect error details:

https://connectrpc.com/docs/go/errors#error-details

Note: As a customer, you should not need to handle this message directly unless writing a custom low-level SDK. Instead, language-specific SDKs will provide a more user-friendly error object that wraps this message.

func (*StatelyErrorDetails) CloneMessageVT

func (m *StatelyErrorDetails) CloneMessageVT() proto.Message

func (*StatelyErrorDetails) CloneVT

func (m *StatelyErrorDetails) CloneVT() *StatelyErrorDetails

func (*StatelyErrorDetails) Descriptor

func (*StatelyErrorDetails) Descriptor() ([]byte, []int)

Deprecated: Use StatelyErrorDetails.ProtoReflect.Descriptor instead.

func (*StatelyErrorDetails) EqualMessageVT

func (this *StatelyErrorDetails) EqualMessageVT(thatMsg proto.Message) bool

func (*StatelyErrorDetails) EqualVT

func (this *StatelyErrorDetails) EqualVT(that *StatelyErrorDetails) bool

func (*StatelyErrorDetails) GetCode

func (x *StatelyErrorDetails) GetCode() uint32

func (*StatelyErrorDetails) GetMessage

func (x *StatelyErrorDetails) GetMessage() string

func (*StatelyErrorDetails) GetStatelyCode

func (x *StatelyErrorDetails) GetStatelyCode() string

func (*StatelyErrorDetails) GetUpstreamCause

func (x *StatelyErrorDetails) GetUpstreamCause() string

func (*StatelyErrorDetails) MarshalToSizedBufferVT

func (m *StatelyErrorDetails) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*StatelyErrorDetails) MarshalToVT

func (m *StatelyErrorDetails) MarshalToVT(dAtA []byte) (int, error)

func (*StatelyErrorDetails) MarshalVT

func (m *StatelyErrorDetails) MarshalVT() (dAtA []byte, err error)

func (*StatelyErrorDetails) ProtoMessage

func (*StatelyErrorDetails) ProtoMessage()

func (*StatelyErrorDetails) ProtoReflect

func (x *StatelyErrorDetails) ProtoReflect() protoreflect.Message

func (*StatelyErrorDetails) Reset

func (x *StatelyErrorDetails) Reset()

func (*StatelyErrorDetails) SizeVT

func (m *StatelyErrorDetails) SizeVT() (n int)

func (*StatelyErrorDetails) String

func (x *StatelyErrorDetails) String() string

func (*StatelyErrorDetails) UnmarshalVT

func (m *StatelyErrorDetails) UnmarshalVT(dAtA []byte) error