genproto: google.golang.org/genproto/googleapis/rpc/status Index | Files

package status

import "google.golang.org/genproto/googleapis/rpc/status"

Index

Package Files

status.pb.go

Variables

var File_google_rpc_status_proto protoreflect.FileDescriptor

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 []*anypb.Any `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty"`
    // contains filtered or unexported fields
}

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](https://github.com/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](https://cloud.google.com/apis/design/errors).

func (*Status) Descriptor Uses

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

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetCode Uses

func (x *Status) GetCode() int32

func (*Status) GetDetails Uses

func (x *Status) GetDetails() []*anypb.Any

func (*Status) GetMessage Uses

func (x *Status) GetMessage() string

func (*Status) ProtoMessage Uses

func (*Status) ProtoMessage()

func (*Status) ProtoReflect Uses

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

func (*Status) Reset Uses

func (x *Status) Reset()

func (*Status) String Uses

func (x *Status) String() string

Package status imports 6 packages (graph) and is imported by 295 packages. Updated 2020-09-03. Refresh now. Tools for package owners.