package cs3.rpc.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

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`.

Used in: Status

CODE_INVALID = 0
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_OK = 1
Not an error; returned on success HTTP Mapping: 200 OK
CODE_CANCELLED = 2
The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request
CODE_UNKNOWN = 3
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_INVALID_ARGUMENT = 4
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_DEADLINE_EXCEEDED = 5
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_NOT_FOUND = 6
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_ALREADY_EXISTS = 7
The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict
CODE_PERMISSION_DENIED = 8
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_UNAUTHENTICATED = 9
The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized
CODE_RESOURCE_EXHAUSTED = 10
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_FAILED_PRECONDITION = 11
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_ABORTED = 12
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_OUT_OF_RANGE = 13
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_UNIMPLEMENTED = 14
The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented
CODE_INTERNAL = 15
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_UNAVAILABLE = 16
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_DATA_LOSS = 17
Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error
CODE_REDIRECTION = 18
Redirects the operation to another location. Used in a Status reponse with a reference to the target URI.
CODE_INSUFFICIENT_STORAGE = 19
The operation could not be performed because there is not enough storage available. This can be because of lack of real storage space or because of the exceeding of a quota associated to a storage. HTTP Mapping: 507 Insufficient Storage
CODE_LOCKED = 20
The ability to lock a resource is specific to some WebDAV servers. The HTTP 423 Locked error response code indicates that either the resources tentatively targeted by is locked, meaning it can't be accessed. HTTP Mapping: 423 Locked
CODE_TOO_EARLY = 21
The server returns the response status code to indicate that it has received the request but is not going to process it because an asynchronous job that has been started is still being processed and the result can not yet be provided. HTTP Mapping: 425 Too Early

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.

Code code = 1
REQUIRED. The status code, which should be an enum value of [cs3.rpc.code][cs3.rpc.code].
string message = 2
OPTIONAL. A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the
string trace = 3
OPTIONAL. A trace added to the response for helping support to identify client problems.
string target_uri = 4
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.
optional types.v1beta1.OpaqueEntry InnerError = 5
OPTIONAL. InnerError represents an encoded error. This makes it possible to transport error types and match them on the client side by type. The InnerError pattern originates from graph.

package cs3.rpc.v1beta1

enum Code

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

CODE_INSUFFICIENT_STORAGE = 19

CODE_LOCKED = 20

CODE_TOO_EARLY = 21

message Status

Code code = 1

string message = 2

string trace = 3

string target_uri = 4

optional types.v1beta1.OpaqueEntry InnerError = 5