Documentation ¶
Index ¶
- Variables
- type EmptyResponse
- type Error
- func (*Error) Descriptor() ([]byte, []int)deprecated
- func (x *Error) GetDetails() *ErrorDetails
- func (x *Error) GetKind() string
- func (x *Error) GetMessage() string
- func (x *Error) GetOp() string
- func (*Error) ProtoMessage()
- func (x *Error) ProtoReflect() protoreflect.Message
- func (x *Error) Reset()
- func (x *Error) String() string
- type ErrorDetails
- func (*ErrorDetails) Descriptor() ([]byte, []int)deprecated
- func (x *ErrorDetails) GetRequestFields() []*FieldError
- func (x *ErrorDetails) GetWrappedErrors() []*WrappedError
- func (*ErrorDetails) ProtoMessage()
- func (x *ErrorDetails) ProtoReflect() protoreflect.Message
- func (x *ErrorDetails) Reset()
- func (x *ErrorDetails) String() string
- type FieldError
- type WrappedError
- func (*WrappedError) Descriptor() ([]byte, []int)deprecated
- func (x *WrappedError) GetMessage() string
- func (x *WrappedError) GetOp() string
- func (*WrappedError) ProtoMessage()
- func (x *WrappedError) ProtoReflect() protoreflect.Message
- func (x *WrappedError) Reset()
- func (x *WrappedError) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_controller_api_v1_empty_msg_proto protoreflect.FileDescriptor
View Source
var File_controller_api_v1_error_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type EmptyResponse ¶ added in v0.7.0
type EmptyResponse struct {
// contains filtered or unexported fields
}
EmptyResponse represents an empty response
func (*EmptyResponse) Descriptor
deprecated
added in
v0.7.0
func (*EmptyResponse) Descriptor() ([]byte, []int)
Deprecated: Use EmptyResponse.ProtoReflect.Descriptor instead.
func (*EmptyResponse) ProtoMessage ¶ added in v0.7.0
func (*EmptyResponse) ProtoMessage()
func (*EmptyResponse) ProtoReflect ¶ added in v0.7.0
func (x *EmptyResponse) ProtoReflect() protoreflect.Message
func (*EmptyResponse) Reset ¶ added in v0.7.0
func (x *EmptyResponse) Reset()
func (*EmptyResponse) String ¶ added in v0.7.0
func (x *EmptyResponse) String() string
type Error ¶
type Error struct { // The kind of error this is. Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"` // An string indicating what operation was being run when the error was returned. Op string `protobuf:"bytes,2,opt,name=op,proto3" json:"op,omitempty"` // A human-readable explanation specific to this occurrence of the error. Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"` // Additional metadata regarding the error. Depending on the error, different fields will be populated. Details *ErrorDetails `protobuf:"bytes,4,opt,name=details,proto3" json:"details,omitempty"` // contains filtered or unexported fields }
Error is returned by the JSON API when an error occurs.
func (*Error) Descriptor
deprecated
func (*Error) GetDetails ¶
func (x *Error) GetDetails() *ErrorDetails
func (*Error) GetMessage ¶
func (*Error) ProtoMessage ¶
func (*Error) ProtoMessage()
func (*Error) ProtoReflect ¶
func (x *Error) ProtoReflect() protoreflect.Message
type ErrorDetails ¶
type ErrorDetails struct { // Request-field-specific error details. RequestFields []*FieldError `protobuf:"bytes,1,rep,name=request_fields,proto3" json:"request_fields,omitempty"` // The errors that were wrapped in the backend for this returned error. WrappedErrors []*WrappedError `protobuf:"bytes,2,rep,name=wrapped_errors,proto3" json:"wrapped_errors,omitempty"` // contains filtered or unexported fields }
Additional details regarding a specific error.
func (*ErrorDetails) Descriptor
deprecated
func (*ErrorDetails) Descriptor() ([]byte, []int)
Deprecated: Use ErrorDetails.ProtoReflect.Descriptor instead.
func (*ErrorDetails) GetRequestFields ¶
func (x *ErrorDetails) GetRequestFields() []*FieldError
func (*ErrorDetails) GetWrappedErrors ¶ added in v0.1.3
func (x *ErrorDetails) GetWrappedErrors() []*WrappedError
func (*ErrorDetails) ProtoMessage ¶
func (*ErrorDetails) ProtoMessage()
func (*ErrorDetails) ProtoReflect ¶
func (x *ErrorDetails) ProtoReflect() protoreflect.Message
func (*ErrorDetails) Reset ¶
func (x *ErrorDetails) Reset()
func (*ErrorDetails) String ¶
func (x *ErrorDetails) String() string
type FieldError ¶
type FieldError struct { // The name of the field. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The description of the error. Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // contains filtered or unexported fields }
FieldErrors contains error information on a per field basis.
func (*FieldError) Descriptor
deprecated
func (*FieldError) Descriptor() ([]byte, []int)
Deprecated: Use FieldError.ProtoReflect.Descriptor instead.
func (*FieldError) GetDescription ¶
func (x *FieldError) GetDescription() string
func (*FieldError) GetName ¶
func (x *FieldError) GetName() string
func (*FieldError) ProtoMessage ¶
func (*FieldError) ProtoMessage()
func (*FieldError) ProtoReflect ¶
func (x *FieldError) ProtoReflect() protoreflect.Message
func (*FieldError) Reset ¶
func (x *FieldError) Reset()
func (*FieldError) String ¶
func (x *FieldError) String() string
type WrappedError ¶ added in v0.1.3
type WrappedError struct { // An string indicating what operation was being run when the wrapped error was created. Op string `protobuf:"bytes,1,opt,name=op,proto3" json:"op,omitempty"` Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` // contains filtered or unexported fields }
Error information relevant to an error that was wrapped by the backend.
func (*WrappedError) Descriptor
deprecated
added in
v0.1.3
func (*WrappedError) Descriptor() ([]byte, []int)
Deprecated: Use WrappedError.ProtoReflect.Descriptor instead.
func (*WrappedError) GetMessage ¶ added in v0.1.3
func (x *WrappedError) GetMessage() string
func (*WrappedError) GetOp ¶ added in v0.1.3
func (x *WrappedError) GetOp() string
func (*WrappedError) ProtoMessage ¶ added in v0.1.3
func (*WrappedError) ProtoMessage()
func (*WrappedError) ProtoReflect ¶ added in v0.1.3
func (x *WrappedError) ProtoReflect() protoreflect.Message
func (*WrappedError) Reset ¶ added in v0.1.3
func (x *WrappedError) Reset()
func (*WrappedError) String ¶ added in v0.1.3
func (x *WrappedError) String() string
Click to show internal directories.
Click to hide internal directories.