goapb

package
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 22, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package goapb contains protocol buffer message types used by the code generation logic.

Index

Constants

This section is empty.

Variables

View Source
var File_goadesign_goa_error_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ErrorField

type ErrorField struct {

	// name is the canonical error name (e.g., invalid_format, missing_field).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// field is the field path associated with the error (e.g., "message.from").
	Field string `protobuf:"bytes,2,opt,name=field,proto3" json:"field,omitempty"`
	// msg is the human-readable error for the specific field.
	Msg string `protobuf:"bytes,3,opt,name=msg,proto3" json:"msg,omitempty"`
	// contains filtered or unexported fields
}

ErrorField captures a single validation issue.

func (*ErrorField) Descriptor deprecated

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

Deprecated: Use ErrorField.ProtoReflect.Descriptor instead.

func (*ErrorField) GetField

func (x *ErrorField) GetField() string

func (*ErrorField) GetMsg

func (x *ErrorField) GetMsg() string

func (*ErrorField) GetName

func (x *ErrorField) GetName() string

func (*ErrorField) ProtoMessage

func (*ErrorField) ProtoMessage()

func (*ErrorField) ProtoReflect

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

func (*ErrorField) Reset

func (x *ErrorField) Reset()

func (*ErrorField) String

func (x *ErrorField) String() string

type ErrorResponse

type ErrorResponse struct {

	// name is the name for that class of errors.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// id is the unique error instance identifier.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// msg describes the specific error occurrence.
	Msg string `protobuf:"bytes,3,opt,name=msg,proto3" json:"msg,omitempty"`
	// temporary indicates whether the error is temporary.
	Temporary bool `protobuf:"varint,4,opt,name=temporary,proto3" json:"temporary,omitempty"`
	// timeout indicates whether the error is a timeout.
	Timeout bool `protobuf:"varint,5,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// fault indicates whether the error is a server-side fault.
	Fault bool `protobuf:"varint,6,opt,name=fault,proto3" json:"fault,omitempty"`
	// history contains individual error entries when the error is a merge of
	// multiple validation errors (e.g., per-field issues). Optional; older
	// servers/clients may omit/ignore.
	History []*ErrorField `protobuf:"bytes,7,rep,name=history,proto3" json:"history,omitempty"`
	// contains filtered or unexported fields
}

ErrorResponse message defines the error encoded in the gRPC response that correspond to the errors created by the generated code. This is mainly intended for the clients to decode error responses.

func (*ErrorResponse) Descriptor deprecated

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

Deprecated: Use ErrorResponse.ProtoReflect.Descriptor instead.

func (*ErrorResponse) GetFault

func (x *ErrorResponse) GetFault() bool

func (*ErrorResponse) GetHistory

func (x *ErrorResponse) GetHistory() []*ErrorField

func (*ErrorResponse) GetId

func (x *ErrorResponse) GetId() string

func (*ErrorResponse) GetMsg

func (x *ErrorResponse) GetMsg() string

func (*ErrorResponse) GetName

func (x *ErrorResponse) GetName() string

func (*ErrorResponse) GetTemporary

func (x *ErrorResponse) GetTemporary() bool

func (*ErrorResponse) GetTimeout

func (x *ErrorResponse) GetTimeout() bool

func (*ErrorResponse) ProtoMessage

func (*ErrorResponse) ProtoMessage()

func (*ErrorResponse) ProtoReflect

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

func (*ErrorResponse) Reset

func (x *ErrorResponse) Reset()

func (*ErrorResponse) String

func (x *ErrorResponse) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL