public static enum Status.CanonicalCode extends Enum<Status.CanonicalCode>
Enum Constant and Description |
---|
ABORTED
The operation was aborted, typically due to a concurrency issue like sequencer check
failures, transaction aborts, etc.
|
ALREADY_EXISTS
Some entity that we attempted to create (e.g., file or directory) already exists.
|
CANCELLED
The operation was cancelled (typically by the caller).
|
DATA_LOSS
Unrecoverable data loss or corruption.
|
DEADLINE_EXCEEDED
Deadline expired before operation could complete.
|
FAILED_PRECONDITION
Operation was rejected because the system is not in a state required for the operation's
execution.
|
INTERNAL
Internal errors.
|
INVALID_ARGUMENT
Client specified an invalid argument.
|
NOT_FOUND
Some requested entity (e.g., file or directory) was not found.
|
OK
The operation completed successfully.
|
OUT_OF_RANGE
Operation was attempted past the valid range.
|
PERMISSION_DENIED
The caller does not have permission to execute the specified operation.
|
RESOURCE_EXHAUSTED
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system
is out of space.
|
UNAUTHENTICATED
The request does not have valid authentication credentials for the operation.
|
UNAVAILABLE
The service is currently unavailable.
|
UNIMPLEMENTED
Operation is not implemented or not supported/enabled in this service.
|
UNKNOWN
Unknown error.
|
Modifier and Type | Method and Description |
---|---|
Status |
toStatus()
Returns the status that has the current
CanonicalCode .. |
int |
value()
Returns the numerical value of the code.
|
static Status.CanonicalCode |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static Status.CanonicalCode[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final Status.CanonicalCode OK
public static final Status.CanonicalCode CANCELLED
public static final Status.CanonicalCode UNKNOWN
public static final Status.CanonicalCode INVALID_ARGUMENT
public static final Status.CanonicalCode DEADLINE_EXCEEDED
public static final Status.CanonicalCode NOT_FOUND
public static final Status.CanonicalCode ALREADY_EXISTS
public static final Status.CanonicalCode PERMISSION_DENIED
public static final Status.CanonicalCode RESOURCE_EXHAUSTED
public static final Status.CanonicalCode FAILED_PRECONDITION
A litmus test that may help a service implementor in deciding 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., restarting 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 they have first fixed up the directory by deleting files from it.
public static final Status.CanonicalCode ABORTED
See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE.
public static final Status.CanonicalCode OUT_OF_RANGE
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.
public static final Status.CanonicalCode UNIMPLEMENTED
public static final Status.CanonicalCode INTERNAL
public static final Status.CanonicalCode UNAVAILABLE
See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE.
public static final Status.CanonicalCode DATA_LOSS
public static final Status.CanonicalCode UNAUTHENTICATED
public static Status.CanonicalCode[] values()
for (Status.CanonicalCode c : Status.CanonicalCode.values()) System.out.println(c);
public static Status.CanonicalCode valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic int value()
public Status toStatus()
CanonicalCode
..CanonicalCode
.