genproto: Index | Files

package status

import ""


Package Files


type Status Uses

type Status struct {
    // The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
    Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
    // A developer-facing error message, which should be in English. Any
    // user-facing error message should be localized and sent in the
    // [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
    Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
    // A list of messages that carry the error details.  There is a common set of
    // message types for APIs to use.
    Details              []*any.Any `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty"`
    XXX_NoUnkeyedLiteral struct{}   `json:"-"`
    XXX_unrecognized     []byte     `json:"-"`
    XXX_sizecache        int32      `json:"-"`

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC]( Each `Status` message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the [API Design Guide](

func (*Status) Descriptor Uses

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

func (*Status) GetCode Uses

func (m *Status) GetCode() int32

func (*Status) GetDetails Uses

func (m *Status) GetDetails() []*any.Any

func (*Status) GetMessage Uses

func (m *Status) GetMessage() string

func (*Status) ProtoMessage Uses

func (*Status) ProtoMessage()

func (*Status) Reset Uses

func (m *Status) Reset()

func (*Status) String Uses

func (m *Status) String() string

func (*Status) XXX_DiscardUnknown Uses

func (m *Status) XXX_DiscardUnknown()

func (*Status) XXX_Marshal Uses

func (m *Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Status) XXX_Merge Uses

func (m *Status) XXX_Merge(src proto.Message)

func (*Status) XXX_Size Uses

func (m *Status) XXX_Size() int

func (*Status) XXX_Unmarshal Uses

func (m *Status) XXX_Unmarshal(b []byte) error

Package status imports 4 packages (graph) and is imported by 187 packages. Updated 2020-01-23. Refresh now. Tools for package owners.