public enum Code extends Enum<Code> implements com.google.protobuf.ProtocolMessageEnum
The canonical error codes for TensorFlow APIs. Warnings: - Do not change any numeric assignments. - Changes to this list should only be made if there is a compelling need that can't be satisfied in another way. Such changes must be approved by at least two OWNERS. 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.Protobuf enum
tensorflow.error.Code
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.
|
DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD_
An extra enum entry to prevent people from writing code that
fails to compile when a new code is added.
|
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
Not an error; returned on success
|
OUT_OF_RANGE
Operation tried to iterate past the valid input 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.
|
UNRECOGNIZED |
Modifier and Type | Field and Description |
---|---|
static int |
ABORTED_VALUE
The operation was aborted, typically due to a concurrency issue
like sequencer check failures, transaction aborts, etc.
|
static int |
ALREADY_EXISTS_VALUE
Some entity that we attempted to create (e.g., file or directory)
already exists.
|
static int |
CANCELLED_VALUE
The operation was cancelled (typically by the caller).
|
static int |
DATA_LOSS_VALUE
Unrecoverable data loss or corruption.
|
static int |
DEADLINE_EXCEEDED_VALUE
Deadline expired before operation could complete.
|
static int |
DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD__VALUE
An extra enum entry to prevent people from writing code that
fails to compile when a new code is added.
|
static int |
FAILED_PRECONDITION_VALUE
Operation was rejected because the system is not in a state
required for the operation's execution.
|
static int |
INTERNAL_VALUE
Internal errors.
|
static int |
INVALID_ARGUMENT_VALUE
Client specified an invalid argument.
|
static int |
NOT_FOUND_VALUE
Some requested entity (e.g., file or directory) was not found.
|
static int |
OK_VALUE
Not an error; returned on success
|
static int |
OUT_OF_RANGE_VALUE
Operation tried to iterate past the valid input range.
|
static int |
PERMISSION_DENIED_VALUE
The caller does not have permission to execute the specified
operation.
|
static int |
RESOURCE_EXHAUSTED_VALUE
Some resource has been exhausted, perhaps a per-user quota, or
perhaps the entire file system is out of space.
|
static int |
UNAUTHENTICATED_VALUE
The request does not have valid authentication credentials for the
operation.
|
static int |
UNAVAILABLE_VALUE
The service is currently unavailable.
|
static int |
UNIMPLEMENTED_VALUE
Operation is not implemented or not supported/enabled in this service.
|
static int |
UNKNOWN_VALUE
Unknown error.
|
Modifier and Type | Method and Description |
---|---|
static Code |
forNumber(int value) |
static com.google.protobuf.Descriptors.EnumDescriptor |
getDescriptor() |
com.google.protobuf.Descriptors.EnumDescriptor |
getDescriptorForType() |
int |
getNumber() |
com.google.protobuf.Descriptors.EnumValueDescriptor |
getValueDescriptor() |
static com.google.protobuf.Internal.EnumLiteMap<Code> |
internalGetValueMap() |
static Code |
valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) |
static Code |
valueOf(int value)
Deprecated.
Use
forNumber(int) instead. |
static Code |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static Code[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final Code OK
Not an error; returned on success
OK = 0;
public static final Code CANCELLED
The operation was cancelled (typically by the caller).
CANCELLED = 1;
public static final Code 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.
UNKNOWN = 2;
public static final Code INVALID_ARGUMENT
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).
INVALID_ARGUMENT = 3;
public static final Code DEADLINE_EXCEEDED
Deadline expired before 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.
DEADLINE_EXCEEDED = 4;
public static final Code NOT_FOUND
Some requested entity (e.g., file or directory) was not found. For privacy reasons, this code *may* be returned when the client does not have the access right to the entity.
NOT_FOUND = 5;
public static final Code ALREADY_EXISTS
Some entity that we attempted to create (e.g., file or directory) already exists.
ALREADY_EXISTS = 6;
public static final Code PERMISSION_DENIED
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).
PERMISSION_DENIED = 7;
public static final Code UNAUTHENTICATED
The request does not have valid authentication credentials for the operation.
UNAUTHENTICATED = 16;
public static final Code RESOURCE_EXHAUSTED
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
RESOURCE_EXHAUSTED = 8;
public static final Code FAILED_PRECONDITION
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 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. (d) Use FAILED_PRECONDITION 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.
FAILED_PRECONDITION = 9;
public static final Code ABORTED
The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE.
ABORTED = 10;
public static final Code OUT_OF_RANGE
Operation tried to iterate past the valid input 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.
OUT_OF_RANGE = 11;
public static final Code UNIMPLEMENTED
Operation is not implemented or not supported/enabled in this service.
UNIMPLEMENTED = 12;
public static final Code INTERNAL
Internal errors. Means some invariant expected by the underlying system has been broken. If you see one of these errors, something is very broken.
INTERNAL = 13;
public static final Code UNAVAILABLE
The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff. See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE.
UNAVAILABLE = 14;
public static final Code DATA_LOSS
Unrecoverable data loss or corruption.
DATA_LOSS = 15;
public static final Code DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD_
An extra enum entry to prevent people from writing code that fails to compile when a new code is added. Nobody should ever reference this enumeration entry. In particular, if you write C++ code that switches on this enumeration, add a default: case instead of a case that mentions this enumeration entry. Nobody should rely on the value (currently 20) listed here. It may change in the future.
DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD_ = 20;
public static final Code UNRECOGNIZED
public static final int OK_VALUE
Not an error; returned on success
OK = 0;
public static final int CANCELLED_VALUE
The operation was cancelled (typically by the caller).
CANCELLED = 1;
public static final int UNKNOWN_VALUE
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.
UNKNOWN = 2;
public static final int INVALID_ARGUMENT_VALUE
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).
INVALID_ARGUMENT = 3;
public static final int DEADLINE_EXCEEDED_VALUE
Deadline expired before 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.
DEADLINE_EXCEEDED = 4;
public static final int NOT_FOUND_VALUE
Some requested entity (e.g., file or directory) was not found. For privacy reasons, this code *may* be returned when the client does not have the access right to the entity.
NOT_FOUND = 5;
public static final int ALREADY_EXISTS_VALUE
Some entity that we attempted to create (e.g., file or directory) already exists.
ALREADY_EXISTS = 6;
public static final int PERMISSION_DENIED_VALUE
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).
PERMISSION_DENIED = 7;
public static final int UNAUTHENTICATED_VALUE
The request does not have valid authentication credentials for the operation.
UNAUTHENTICATED = 16;
public static final int RESOURCE_EXHAUSTED_VALUE
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
RESOURCE_EXHAUSTED = 8;
public static final int FAILED_PRECONDITION_VALUE
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 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. (d) Use FAILED_PRECONDITION 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.
FAILED_PRECONDITION = 9;
public static final int ABORTED_VALUE
The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE.
ABORTED = 10;
public static final int OUT_OF_RANGE_VALUE
Operation tried to iterate past the valid input 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.
OUT_OF_RANGE = 11;
public static final int UNIMPLEMENTED_VALUE
Operation is not implemented or not supported/enabled in this service.
UNIMPLEMENTED = 12;
public static final int INTERNAL_VALUE
Internal errors. Means some invariant expected by the underlying system has been broken. If you see one of these errors, something is very broken.
INTERNAL = 13;
public static final int UNAVAILABLE_VALUE
The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff. See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE.
UNAVAILABLE = 14;
public static final int DATA_LOSS_VALUE
Unrecoverable data loss or corruption.
DATA_LOSS = 15;
public static final int DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD__VALUE
An extra enum entry to prevent people from writing code that fails to compile when a new code is added. Nobody should ever reference this enumeration entry. In particular, if you write C++ code that switches on this enumeration, add a default: case instead of a case that mentions this enumeration entry. Nobody should rely on the value (currently 20) listed here. It may change in the future.
DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD_ = 20;
public static Code[] values()
for (Code c : Code.values()) System.out.println(c);
public static Code 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 final int getNumber()
getNumber
in interface com.google.protobuf.Internal.EnumLite
getNumber
in interface com.google.protobuf.ProtocolMessageEnum
@Deprecated public static Code valueOf(int value)
forNumber(int)
instead.public static Code forNumber(int value)
public static com.google.protobuf.Internal.EnumLiteMap<Code> internalGetValueMap()
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
getValueDescriptor
in interface com.google.protobuf.ProtocolMessageEnum
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.ProtocolMessageEnum
public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
public static Code valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
Copyright © 2015–2019. All rights reserved.