errdetails

Documentation

Overview

Package errdetails provides error detail for gRPC status

Index

• Constants
• Variables
• func AnyToErrorDetail(a *types.Any) proto.Message
• func Serialize(objs ...any) string
• type BadRequest
• type BadRequestFieldViolation
• type DebugInfo
  • func DebugInfoFromInfoDetail(v *info.Detail) (debug *DebugInfo)
• type Detail
  • func (d *Detail) MarshalJSON() (body []byte, err error)
• type ErrorInfo
• type Help
• type HelpLink
• type LocalizedMessage
• type PreconditionFailure
• type PreconditionFailureViolation
• type QuotaFailure
• type QuotaFailureViolation
• type RequestInfo
• type ResourceInfo
• type RetryInfo

Constants

const (
	ValdResourceOwner          = "vdaas.org vald team <vald@vdaas.org>"
	ValdGRPCResourceTypePrefix = "github.com/vdaas/vald/apis/grpc/v1"
)

Variables

var (
	DebugInfoMessageName                    = string(new(DebugInfo).ProtoReflect().Descriptor().FullName().Name())
	ErrorInfoMessageName                    = string(new(ErrorInfo).ProtoReflect().Descriptor().FullName().Name())
	BadRequestMessageName                   = string(new(BadRequest).ProtoReflect().Descriptor().FullName().Name())
	BadRequestFieldViolationMessageName     = string(new(BadRequestFieldViolation).ProtoReflect().Descriptor().FullName().Name())
	LocalizedMessageMessageName             = string(new(LocalizedMessage).ProtoReflect().Descriptor().FullName().Name())
	PreconditionFailureMessageName          = string(new(PreconditionFailure).ProtoReflect().Descriptor().FullName().Name())
	PreconditionFailureViolationMessageName = string(new(PreconditionFailureViolation).ProtoReflect().Descriptor().FullName().Name())
	HelpMessageName                         = string(new(Help).ProtoReflect().Descriptor().FullName().Name())
	HelpLinkMessageName                     = string(new(HelpLink).ProtoReflect().Descriptor().FullName().Name())
	QuotaFailureMessageName                 = string(new(QuotaFailure).ProtoReflect().Descriptor().FullName().Name())
	QuotaFailureViolationMessageName        = string(new(QuotaFailureViolation).ProtoReflect().Descriptor().FullName().Name())
	RequestInfoMessageName                  = string(new(RequestInfo).ProtoReflect().Descriptor().FullName().Name())
	ResourceInfoMessageName                 = string(new(ResourceInfo).ProtoReflect().Descriptor().FullName().Name())
	RetryInfoMessageName                    = string(new(RetryInfo).ProtoReflect().Descriptor().FullName().Name())
)

Functions

func AnyToErrorDetail

func AnyToErrorDetail(a *types.Any) proto.Message

func Serialize

func Serialize(objs ...any) string

Types

type BadRequest

type BadRequest = errdetails.BadRequest

type BadRequestFieldViolation

type BadRequestFieldViolation = errdetails.BadRequest_FieldViolation

type DebugInfo

type DebugInfo = errdetails.DebugInfo

func DebugInfoFromInfoDetail

func DebugInfoFromInfoDetail(v *info.Detail) (debug *DebugInfo)

type Detail

type Detail struct {
	TypeURL string        `json:"type_url,omitempty" yaml:"type_url"`
	Message proto.Message `json:"message,omitempty"  yaml:"message"`
}

func (*Detail) MarshalJSON

func (d *Detail) MarshalJSON() (body []byte, err error)

type ErrorInfo

type ErrorInfo = errdetails.ErrorInfo

type Help

type Help = errdetails.Help

type HelpLink

type HelpLink = errdetails.Help_Link

type LocalizedMessage

type LocalizedMessage = errdetails.LocalizedMessage

type PreconditionFailure

type PreconditionFailure = errdetails.PreconditionFailure

type PreconditionFailureViolation

type PreconditionFailureViolation = errdetails.PreconditionFailure_Violation

type QuotaFailure

type QuotaFailure = errdetails.QuotaFailure

type QuotaFailureViolation

type QuotaFailureViolation = errdetails.QuotaFailure_Violation

type RequestInfo

type RequestInfo = errdetails.RequestInfo

type ResourceInfo

type ResourceInfo = errdetails.ResourceInfo

type RetryInfo

type RetryInfo = errdetails.RetryInfo