Documentation
¶
Index ¶
- type Status
- func Aborted(ctx context.Context, details ...proto.Message) *Status
- func AlreadyExists(ctx context.Context, details ...proto.Message) *Status
- func Canceled(ctx context.Context, details ...proto.Message) *Status
- func DataLoss(ctx context.Context, details ...proto.Message) *Status
- func DeadlineExceeded(ctx context.Context, details ...proto.Message) *Status
- func FailedPrecondition(ctx context.Context, details ...proto.Message) *Status
- func FromError(err error) *Status
- func FromStatus(s *status.Status) *Status
- func Internal(ctx context.Context, details ...proto.Message) *Status
- func InvalidArgument(ctx context.Context, details ...proto.Message) *Status
- func New(code int32, message string) *Status
- func NoContent(ctx context.Context, details ...proto.Message) *Status
- func NotFound(ctx context.Context, details ...proto.Message) *Status
- func OK(ctx context.Context, details ...proto.Message) *Status
- func OutOfRange(ctx context.Context, details ...proto.Message) *Status
- func PermissionDenied(ctx context.Context, details ...proto.Message) *Status
- func ResourceExhausted(ctx context.Context, details ...proto.Message) *Status
- func Unauthenticated(ctx context.Context, details ...proto.Message) *Status
- func Unavailable(ctx context.Context, details ...proto.Message) *Status
- func Unimplemented(ctx context.Context, details ...proto.Message) *Status
- func Unknown(ctx context.Context, details ...proto.Message) *Status
- func (s *Status) AppendDetail(detail proto.Message) *Status
- func (s *Status) Err() error
- func (s *Status) Error() string
- func (s *Status) GRPCStatus() *status.Status
- func (s *Status) HTTPStatusCode() int
- func (s *Status) WithDetails(details ...proto.Message) *Status
- func (s *Status) WithMessage(msg string) *Status
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Status ¶
Status 统一错误响应内容
func Aborted ¶
Aborted indicates the operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.
See litmus test above for deciding between FailedPrecondition, Aborted, and Unavailable.
For example, Couldn’t acquire lock on resource ‘xxx’.
func AlreadyExists ¶
AlreadyExists means an attempt to create an entity failed because one already exists. For example, Resource 'xxx' already exists.
func DeadlineExceeded ¶
DeadlineExceeded means operation expired before completion. 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. This will happen only if the caller sets a deadline that is shorter than the method's default deadline (i.e. requested deadline is not enough for the server to process the request) and the request did not finish within the deadline.
func FailedPrecondition ¶
FailedPrecondition indicates operation was rejected because the system is not in a state required for the operation's execution. For example, directory to be deleted may be non-empty, an rmdir operation is applied to a non-directory, etc.
A litmus test that may help a service implementor in deciding between FailedPrecondition, 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., restarting a read-modify-write sequence).
(c) Use FailedPrecondition 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, FailedPrecondition
should be returned since the client should not retry unless
they have first fixed up the directory by deleting files from it.
(d) Use FailedPrecondition if the client performs conditional
REST Get/Update/Delete on a resource and the resource on the
server does not match the condition. E.g., conflicting
read-modify-write on the same resource.
For example, Resource xxx is a non-empty directory, so it cannot be deleted.
func FromStatus ¶
FromStatus 用于转换 google.rpc.Status 类型为统一错误响应结构
func Internal ¶
Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken.
func InvalidArgument ¶
InvalidArgument indicates client specified an invalid argument. Note that this differs from FailedPrecondition. It indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). For example, Request field x.y.z is xxx, expected one of [yyy, zzz].
func NoContent ¶ added in v0.3.3
NoContent indicates that the server has successfully fulfilled the request and that there is no additional content to send in the response content.
func OutOfRange ¶
OutOfRange means operation was attempted past the valid range. E.g., seeking or reading past end of file.
Unlike InvalidArgument, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate InvalidArgument if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OutOfRange if asked to read from an offset past the current file size.
There is a fair bit of overlap between FailedPrecondition and OutOfRange. We recommend using OutOfRange (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OutOfRange error to detect when they are done.
For example, Parameter 'age' is out of range [0, 125].
func PermissionDenied ¶
PermissionDenied indicates the caller does not have permission to execute the specified operation. It must not be used for rejections caused by exhausting some resource (use ResourceExhausted instead for those errors). It must not be used if the caller cannot be identified (use Unauthenticated instead for those errors). For example, Permission 'xxx' denied on file 'yyy'. This can happen because the OAuth token does not have the right scopes, the client doesn't have permission, or the API has not been enabled for the client project.
func ResourceExhausted ¶
ResourceExhausted indicates some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. For example, Quota limit 'xxx' exceeded. The client should look for google.rpc.QuotaFailure error detail for more information.
func Unauthenticated ¶
Unauthenticated indicates the request does not have valid authentication credentials for the operation.
func Unavailable ¶
Unavailable indicates the service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations.
See litmus test above for deciding between FailedPrecondition, Aborted, and Unavailable.
func Unimplemented ¶
Unimplemented indicates operation is not implemented or not supported/enabled in this service. For example, Method 'xxx' not implemented.
func Unknown ¶
Unknown error. An example of where this error may be returned is if 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.
func (*Status) AppendDetail ¶
AppendDetail 添加错误详情内容
func (*Status) GRPCStatus ¶
GRPCStatus 用于返回google grpc status.Status结构
func (*Status) HTTPStatusCode ¶
HTTPStatusCode 用于转换错误代码为标准HTTP状态码
func (*Status) WithDetails ¶
WithDetails returns a new status with the provided details messages appended to the status.
Source Files