Documentation
¶
Index ¶
- Variables
- type Code
- type Status
- func (*Status) Descriptor() ([]byte, []int)
- func (m *Status) GetCode() Code
- func (m *Status) GetData() *types.Struct
- func (m *Status) GetDetails() []*types.Any
- func (m *Status) GetError() string
- func (m *Status) GetMessage() string
- func (m *Status) Marshal() (dAtA []byte, err error)
- func (m *Status) MarshalTo(dAtA []byte) (int, error)
- func (*Status) ProtoMessage()
- func (m *Status) Reset()
- func (m *Status) Size() (n int)
- func (m *Status) String() string
- func (m *Status) Unmarshal(dAtA []byte) error
- func (m *Status) XXX_DiscardUnknown()
- func (m *Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Status) XXX_Merge(src proto.Message)
- func (m *Status) XXX_Size() int
- func (m *Status) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrInvalidLengthStatus = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowStatus = fmt.Errorf("proto: integer overflow") )
View Source
var Code_name = map[int32]string{
0: "OK",
1: "CANCELLED",
2: "UNKNOWN",
100000: "INVALID_ARGUMENT",
100014: "DEADLINE_EXCEEDED",
100005: "NOT_FOUND",
100007: "ALREADY_EXISTS",
100004: "PERMISSION_DENIED",
100003: "UNAUTHENTICATED",
100008: "RESOURCE_EXHAUSTED",
100001: "FAILED_PRECONDITION",
100006: "ABORTED",
100002: "OUT_OF_RANGE",
100012: "UNIMPLEMENTED",
100011: "INTERNAL",
100013: "UNAVAILABLE",
100009: "DATA_LOSS",
}
View Source
var Code_value = map[string]int32{
"OK": 0,
"CANCELLED": 1,
"UNKNOWN": 2,
"INVALID_ARGUMENT": 100000,
"DEADLINE_EXCEEDED": 100014,
"NOT_FOUND": 100005,
"ALREADY_EXISTS": 100007,
"PERMISSION_DENIED": 100004,
"UNAUTHENTICATED": 100003,
"RESOURCE_EXHAUSTED": 100008,
"FAILED_PRECONDITION": 100001,
"ABORTED": 100006,
"OUT_OF_RANGE": 100002,
"UNIMPLEMENTED": 100012,
"INTERNAL": 100011,
"UNAVAILABLE": 100013,
"DATA_LOSS": 100009,
}
Functions ¶
This section is empty.
Types ¶
type Code ¶
type Code int32
const ( // Not an error; returned on success // // HTTP Mapping: 200 OK Code_OK Code = 0 // The operation was cancelled, typically by the caller. // // HTTP Mapping: 499 Client Closed Request Code_CANCELLED Code = 1 // Unknown error. For example, this error may be returned when // a `Status` value received from another address space belongs to // an error space that is not known in this address space. Also // errors raised by APIs that do not return enough error information // may be converted to this error. // // HTTP Mapping: 500 Internal Server Error Code_UNKNOWN Code = 2 // The client specified an invalid argument. Note that this differs // from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments // that are problematic regardless of the state of the system // (e.g., a malformed file name). // // HTTP Mapping: 400 Bad Request Code_INVALID_ARGUMENT Code = 100000 // The deadline expired before the operation could complete. For operations // that change the state of the system, this error may be returned // even if the operation has completed successfully. For example, a // successful response from a server could have been delayed long // enough for the deadline to expire. // // HTTP Mapping: 504 Gateway Timeout Code_DEADLINE_EXCEEDED Code = 100014 // Some requested entity (e.g., file or directory) was not found. // // Note to server developers: if a request is denied for an entire class // of users, such as gradual feature rollout or undocumented whitelist, // `NOT_FOUND` may be used. If a request is denied for some users within // a class of users, such as user-based access control, `PERMISSION_DENIED` // must be used. // // HTTP Mapping: 404 Not Found Code_NOT_FOUND Code = 100005 // The entity that a client attempted to create (e.g., file or directory) // already exists. // // HTTP Mapping: 409 Conflict Code_ALREADY_EXISTS Code = 100007 // The caller does not have permission to execute the specified // operation. `PERMISSION_DENIED` must not be used for rejections // caused by exhausting some resource (use `RESOURCE_EXHAUSTED` // instead for those errors). `PERMISSION_DENIED` must not be // used if the caller can not be identified (use `UNAUTHENTICATED` // instead for those errors). This error code does not imply the // request is valid or the requested entity exists or satisfies // other pre-conditions. // // HTTP Mapping: 403 Forbidden Code_PERMISSION_DENIED Code = 100004 // The request does not have valid authentication credentials for the // operation. // // HTTP Mapping: 401 Unauthorized Code_UNAUTHENTICATED Code = 100003 // Some resource has been exhausted, perhaps a per-user quota, or // perhaps the entire file system is out of space. // // HTTP Mapping: 429 Too Many Requests Code_RESOURCE_EXHAUSTED Code = 100008 // The operation was rejected because the system is not in a state // required for the operation's execution. For example, the directory // to be deleted is non-empty, an rmdir operation is applied to // a non-directory, etc. // // Service implementors can use the following guidelines to decide // between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: // (a) Use `UNAVAILABLE` if the client can retry just the failing call. // (b) Use `ABORTED` if the client should retry at a higher level // (e.g., when a client-specified test-and-set fails, indicating the // client should restart a read-modify-write sequence). // (c) Use `FAILED_PRECONDITION` if the client should not retry until // the system state has been explicitly fixed. E.g., if an "rmdir" // fails because the directory is non-empty, `FAILED_PRECONDITION` // should be returned since the client should not retry unless // the files are deleted from the directory. // // HTTP Mapping: 400 Bad Request Code_FAILED_PRECONDITION Code = 100001 // The operation was aborted, typically due to a concurrency issue such as // a sequencer check failure or transaction abort. // // See the guidelines above for deciding between `FAILED_PRECONDITION`, // `ABORTED`, and `UNAVAILABLE`. // // HTTP Mapping: 409 Conflict Code_ABORTED Code = 100006 // The operation was attempted past the valid range. E.g., seeking or // reading past end-of-file. // // Unlike `INVALID_ARGUMENT`, this error indicates a problem that may // be fixed if the system state changes. For example, a 32-bit file // system will generate `INVALID_ARGUMENT` if asked to read at an // offset that is not in the range [0,2^32-1], but it will generate // `OUT_OF_RANGE` if asked to read from an offset past the current // file size. // // There is a fair bit of overlap between `FAILED_PRECONDITION` and // `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific // error) when it applies so that callers who are iterating through // a space can easily look for an `OUT_OF_RANGE` error to detect when // they are done. // // HTTP Mapping: 400 Bad Request Code_OUT_OF_RANGE Code = 100002 // The operation is not implemented or is not supported/enabled in this // service. // // HTTP Mapping: 501 Not Implemented Code_UNIMPLEMENTED Code = 100012 // Internal errors. This means that some invariants expected by the // underlying system have been broken. This error code is reserved // for serious errors. // // HTTP Mapping: 500 Internal Server Error Code_INTERNAL Code = 100011 // The service is currently unavailable. This is most likely a // transient condition, which can be corrected by retrying with // a backoff. // // See the guidelines above for deciding between `FAILED_PRECONDITION`, // `ABORTED`, and `UNAVAILABLE`. // // HTTP Mapping: 503 Service Unavailable Code_UNAVAILABLE Code = 100013 // Unrecoverable data loss or corruption. // // HTTP Mapping: 500 Internal Server Error Code_DATA_LOSS Code = 100009 )
func (Code) EnumDescriptor ¶
type Status ¶
type Status struct {
// 错误码, 由 giraffe.status.Code 统一定义
Code Code `protobuf:"varint,1,opt,name=code,proto3,enum=status.Code" json:"code,omitempty"`
// 错误描述, 由错误码翻译+错误解释组成, 面向研发者, 要求全英文编写
Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
// 错误解释, 面向用户, 用业务语言描述
Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
// 错误的详细信息, map格式
Data *types.Struct `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
// 错误的详细信息, any格式
Details []*types.Any `protobuf:"bytes,5,rep,name=details,proto3" json:"details,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (*Status) Descriptor ¶
func (*Status) GetDetails ¶
func (*Status) GetMessage ¶
func (*Status) ProtoMessage ¶
func (*Status) ProtoMessage()
func (*Status) XXX_DiscardUnknown ¶
func (m *Status) XXX_DiscardUnknown()
func (*Status) XXX_Marshal ¶
func (*Status) XXX_Unmarshal ¶
Source Files
Click to show internal directories.
Click to hide internal directories.