Package org.tensorflow.framework

Enum Code

  • All Implemented Interfaces:
    Serializable, Comparable<Code>, org.nd4j.shade.protobuf.Internal.EnumLite, org.nd4j.shade.protobuf.ProtocolMessageEnum
    public enum Code
extends Enum<Code>
implements org.nd4j.shade.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 Detail

      • OK

        public static final Code OK
         Not an error; returned on success
        OK = 0;

      • CANCELLED

        public static final Code CANCELLED
         The operation was cancelled (typically by the caller).
        CANCELLED = 1;

      • UNKNOWN

        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;

      • INVALID_ARGUMENT

        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;

      • DEADLINE_EXCEEDED

        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;

      • NOT_FOUND

        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;

      • ALREADY_EXISTS

        public static final Code ALREADY_EXISTS
         Some entity that we attempted to create (e.g., file or directory)
 already exists.
        ALREADY_EXISTS = 6;

      • PERMISSION_DENIED

        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;

      • UNAUTHENTICATED

        public static final Code UNAUTHENTICATED
         The request does not have valid authentication credentials for the
 operation.
        UNAUTHENTICATED = 16;

      • RESOURCE_EXHAUSTED

        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;

      • FAILED_PRECONDITION

        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;

      • ABORTED

        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;

      • OUT_OF_RANGE

        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;

      • UNIMPLEMENTED

        public static final Code UNIMPLEMENTED
         Operation is not implemented or not supported/enabled in this service.
        UNIMPLEMENTED = 12;

      • INTERNAL

        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;

      • UNAVAILABLE

        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;

      • DATA_LOSS

        public static final Code DATA_LOSS
         Unrecoverable data loss or corruption.
        DATA_LOSS = 15;

      • DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD_

        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;

      • UNRECOGNIZED

        public static final Code UNRECOGNIZED

    • Field Detail

      • OK_VALUE

        public static final int OK_VALUE
         Not an error; returned on success
        OK = 0;
        See Also:
        Constant Field Values

      • CANCELLED_VALUE

        public static final int CANCELLED_VALUE
         The operation was cancelled (typically by the caller).
        CANCELLED = 1;
        See Also:
        Constant Field Values

      • UNKNOWN_VALUE

        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;
        See Also:
        Constant Field Values

      • INVALID_ARGUMENT_VALUE

        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;
        See Also:
        Constant Field Values

      • DEADLINE_EXCEEDED_VALUE

        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;
        See Also:
        Constant Field Values

      • NOT_FOUND_VALUE

        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;
        See Also:
        Constant Field Values

      • ALREADY_EXISTS_VALUE

        public static final int ALREADY_EXISTS_VALUE
         Some entity that we attempted to create (e.g., file or directory)
 already exists.
        ALREADY_EXISTS = 6;
        See Also:
        Constant Field Values

      • PERMISSION_DENIED_VALUE

        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;
        See Also:
        Constant Field Values

      • UNAUTHENTICATED_VALUE

        public static final int UNAUTHENTICATED_VALUE
         The request does not have valid authentication credentials for the
 operation.
        UNAUTHENTICATED = 16;
        See Also:
        Constant Field Values

      • RESOURCE_EXHAUSTED_VALUE

        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;
        See Also:
        Constant Field Values

      • FAILED_PRECONDITION_VALUE

        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;
        See Also:
        Constant Field Values

      • ABORTED_VALUE

        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;
        See Also:
        Constant Field Values

      • OUT_OF_RANGE_VALUE

        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;
        See Also:
        Constant Field Values

      • UNIMPLEMENTED_VALUE

        public static final int UNIMPLEMENTED_VALUE
         Operation is not implemented or not supported/enabled in this service.
        UNIMPLEMENTED = 12;
        See Also:
        Constant Field Values

      • INTERNAL_VALUE

        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;
        See Also:
        Constant Field Values

      • UNAVAILABLE_VALUE

        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;
        See Also:
        Constant Field Values

      • DATA_LOSS_VALUE

        public static final int DATA_LOSS_VALUE
         Unrecoverable data loss or corruption.
        DATA_LOSS = 15;
        See Also:
        Constant Field Values

      • DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD__VALUE

        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;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static Code[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Code c : Code.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Code valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface org.nd4j.shade.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface org.nd4j.shade.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static Code valueOf​(int value)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • forNumber

        public static Code forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • internalGetValueMap

        public static org.nd4j.shade.protobuf.Internal.EnumLiteMap<Code> internalGetValueMap()

      • getValueDescriptor

        public final org.nd4j.shade.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface org.nd4j.shade.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final org.nd4j.shade.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface org.nd4j.shade.protobuf.ProtocolMessageEnum

      • getDescriptor

        public static final org.nd4j.shade.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static Code valueOf​(org.nd4j.shade.protobuf.Descriptors.EnumValueDescriptor desc)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null