rpcv1beta1

package
v0.0.0-...-6b5d9df Latest Latest
Warning

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

 Go to latest Published: Jul 15, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Code_name = map[int32]string{
		0:  "CODE_INVALID",
		1:  "CODE_OK",
		2:  "CODE_CANCELLED",
		3:  "CODE_UNKNOWN",
		4:  "CODE_INVALID_ARGUMENT",
		5:  "CODE_DEADLINE_EXCEEDED",
		6:  "CODE_NOT_FOUND",
		7:  "CODE_ALREADY_EXISTS",
		8:  "CODE_PERMISSION_DENIED",
		9:  "CODE_UNAUTHENTICATED",
		10: "CODE_RESOURCE_EXHAUSTED",
		11: "CODE_FAILED_PRECONDITION",
		12: "CODE_ABORTED",
		13: "CODE_OUT_OF_RANGE",
		14: "CODE_UNIMPLEMENTED",
		15: "CODE_INTERNAL",
		16: "CODE_UNAVAILABLE",
		17: "CODE_DATA_LOSS",
		18: "CODE_REDIRECTION",
	}
	Code_value = map[string]int32{
		"CODE_INVALID":             0,
		"CODE_OK":                  1,
		"CODE_CANCELLED":           2,
		"CODE_UNKNOWN":             3,
		"CODE_INVALID_ARGUMENT":    4,
		"CODE_DEADLINE_EXCEEDED":   5,
		"CODE_NOT_FOUND":           6,
		"CODE_ALREADY_EXISTS":      7,
		"CODE_PERMISSION_DENIED":   8,
		"CODE_UNAUTHENTICATED":     9,
		"CODE_RESOURCE_EXHAUSTED":  10,
		"CODE_FAILED_PRECONDITION": 11,
		"CODE_ABORTED":             12,
		"CODE_OUT_OF_RANGE":        13,
		"CODE_UNIMPLEMENTED":       14,
		"CODE_INTERNAL":            15,
		"CODE_UNAVAILABLE":         16,
		"CODE_DATA_LOSS":           17,
		"CODE_REDIRECTION":         18,
	}
)

Enum value maps for Code.

View Source 
var File_cs3_rpc_v1beta1_code_proto protoreflect.FileDescriptor
View Source 
var File_cs3_rpc_v1beta1_status_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Code 

type Code int32

These are the canonical error codes used by CS3 APIs.

Adapted from Google APIs: https://github.com/googleapis/googleapis/

Sometimes multiple error codes may apply. Services should return the most specific error code that applies. For example, prefer `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply. Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`. 

const (
	// A programmer would not intentionally set the code to CODE_INVALID.
	// This code exists to force service implementors to set
	// a specific code for the API call and to not rely on defaults.
	//
	// HTTP Mapping: 500 Internal Server Error
	Code_CODE_INVALID Code = 0
	// Not an error; returned on success
	//
	// HTTP Mapping: 200 OK
	Code_CODE_OK Code = 1
	// The operation was cancelled, typically by the caller.
	//
	// HTTP Mapping: 499 Client Closed Request
	Code_CODE_CANCELLED Code = 2
	// 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_CODE_UNKNOWN Code = 3
	// 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_CODE_INVALID_ARGUMENT Code = 4
	// 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_CODE_DEADLINE_EXCEEDED Code = 5
	// 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_CODE_NOT_FOUND Code = 6
	// The entity that a client attempted to create (e.g., file or directory)
	// already exists.
	//
	// HTTP Mapping: 409 Conflict
	Code_CODE_ALREADY_EXISTS Code = 7
	// 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_CODE_PERMISSION_DENIED Code = 8
	// The request does not have valid authentication credentials for the
	// operation.
	//
	// HTTP Mapping: 401 Unauthorized
	Code_CODE_UNAUTHENTICATED Code = 9
	// 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_CODE_RESOURCE_EXHAUSTED Code = 10
	// 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_CODE_FAILED_PRECONDITION Code = 11
	// 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_CODE_ABORTED Code = 12
	// 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_CODE_OUT_OF_RANGE Code = 13
	// The operation is not implemented or is not supported/enabled in this
	// service.
	//
	// HTTP Mapping: 501 Not Implemented
	Code_CODE_UNIMPLEMENTED Code = 14
	// 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_CODE_INTERNAL Code = 15
	// 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_CODE_UNAVAILABLE Code = 16
	// Unrecoverable data loss or corruption.
	//
	// HTTP Mapping: 500 Internal Server Error
	Code_CODE_DATA_LOSS Code = 17
	// Redirects the operation to another location.
	// Used in a Status reponse with a reference to the target URI.
	Code_CODE_REDIRECTION Code = 18
)

func (Code) Descriptor 

func (Code) Descriptor() protoreflect.EnumDescriptor

func (Code) Enum 

func (x Code) Enum() *Code

func (Code) EnumDescriptor deprecated 

func (Code) EnumDescriptor() ([]byte, []int)

Deprecated: Use Code.Descriptor instead.

func (Code) Number 

func (x Code) Number() protoreflect.EnumNumber

func (Code) String 

func (x Code) String() string

func (Code) Type 

func (Code) Type() protoreflect.EnumType

type Status 

type Status struct {

	// REQUIRED.
	// The status code, which should be an enum value of [cs3.rpc.code][cs3.rpc.code].
	Code Code `protobuf:"varint,1,opt,name=code,proto3,enum=cs3.rpc.v1beta1.Code" json:"code,omitempty"`
	// OPTIONAL.
	// A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// OPTIONAL.
	// A trace added to the response for helping support to identify client problems.
	Trace string `protobuf:"bytes,3,opt,name=trace,proto3" json:"trace,omitempty"`
	// OPTIONAL.
	// A target URI as per RFC3986 to redirect requests to another location.
	// A Status message with CODE_REDIRECT MUST always set the target_uri.
	// https://golang.org/pkg/net/url/#URL provides a quick view of the format.
	TargetUri string `protobuf:"bytes,4,opt,name=target_uri,json=targetUri,proto3" json:"target_uri,omitempty"`
	// contains filtered or unexported fields
}

The `Status` message contains two pieces of data: error code and error message. The error code should be an enum value of [cs3.rpc.code]. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error.

func (*Status) Descriptor deprecated 

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

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetCode 

func (x *Status) GetCode() Code

func (*Status) GetMessage 

func (x *Status) GetMessage() string

func (*Status) GetTargetUri 

func (x *Status) GetTargetUri() string

func (*Status) GetTrace 

func (x *Status) GetTrace() string

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect 

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

func (*Status) Reset 

func (x *Status) Reset()

func (*Status) String 

func (x *Status) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.