Enum Code

java.lang.Object
java.lang.Enum<Code>
com.google.rpc.Code
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Code>, java.lang.constant.Constable
public enum Code extends Enum<Code> implements com.google.protobuf.ProtocolMessageEnum
The canonical error codes for gRPC APIs.


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 google.rpc.Code

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ABORTED
    The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort.
    ALREADY_EXISTS
    The entity that a client 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
    The deadline expired before the operation could complete.
    FAILED_PRECONDITION
    The operation was rejected because the system is not in a state required for the operation's execution.
    INTERNAL
    Internal errors.
    INVALID_ARGUMENT
    The 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
    The 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
    The operation is not implemented or is not supported/enabled in this service.
    UNKNOWN
    Unknown error.
    UNRECOGNIZED
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ABORTED_VALUE
    The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort.
    static final int
    ALREADY_EXISTS_VALUE
    The entity that a client attempted to create (e.g., file or directory) already exists.
    static final int
    CANCELLED_VALUE
    The operation was cancelled, typically by the caller.
    static final int
    DATA_LOSS_VALUE
    Unrecoverable data loss or corruption.
    static final int
    DEADLINE_EXCEEDED_VALUE
    The deadline expired before the operation could complete.
    static final int
    FAILED_PRECONDITION_VALUE
    The operation was rejected because the system is not in a state required for the operation's execution.
    static final int
    INTERNAL_VALUE
    Internal errors.
    static final int
    INVALID_ARGUMENT_VALUE
    The client specified an invalid argument.
    static final int
    NOT_FOUND_VALUE
    Some requested entity (e.g., file or directory) was not found.
    static final int
    OK_VALUE
    Not an error; returned on success.
    static final int
    OUT_OF_RANGE_VALUE
    The operation was attempted past the valid range.
    static final int
    PERMISSION_DENIED_VALUE
    The caller does not have permission to execute the specified operation.
    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.
    static final int
    UNAUTHENTICATED_VALUE
    The request does not have valid authentication credentials for the operation.
    static final int
    UNAVAILABLE_VALUE
    The service is currently unavailable.
    static final int
    UNIMPLEMENTED_VALUE
    The operation is not implemented or is not supported/enabled in this service.
    static final int
    UNKNOWN_VALUE
    Unknown error.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Code
    forNumber(int value)
     
    static final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptor()
     
    final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptorForType()
     
    final int
    getNumber()
     
    final com.google.protobuf.Descriptors.EnumValueDescriptor
    getValueDescriptor()
     
    static com.google.protobuf.Internal.EnumLiteMap<Code>
    internalGetValueMap()
     
    static Code
    valueOf(int value)
    Deprecated.
    static Code
    valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
    Returns the enum constant of this type with the specified name.
    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.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • OK

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

HTTP Mapping: 200 OK
      OK = 0;

    • CANCELLED

      public static final Code CANCELLED
      The operation was cancelled, typically by the caller.

HTTP Mapping: 499 Client Closed Request
      CANCELLED = 1;

    • UNKNOWN

      public static final Code UNKNOWN
      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
      UNKNOWN = 2;

    • INVALID_ARGUMENT

      public static final Code INVALID_ARGUMENT
      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
      INVALID_ARGUMENT = 3;

    • DEADLINE_EXCEEDED

      public static final Code DEADLINE_EXCEEDED
      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
      DEADLINE_EXCEEDED = 4;

    • NOT_FOUND

      public static final Code NOT_FOUND
      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 allowlist,
`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
      NOT_FOUND = 5;

    • ALREADY_EXISTS

      public static final Code ALREADY_EXISTS
      The entity that a client attempted to create (e.g., file or directory)
already exists.

HTTP Mapping: 409 Conflict
      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). This error code does not imply the
request is valid or the requested entity exists or satisfies
other pre-conditions.

HTTP Mapping: 403 Forbidden
      PERMISSION_DENIED = 7;

    • UNAUTHENTICATED

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

HTTP Mapping: 401 Unauthorized
      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.

HTTP Mapping: 429 Too Many Requests
      RESOURCE_EXHAUSTED = 8;

    • FAILED_PRECONDITION

      public static final Code FAILED_PRECONDITION
      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. For
     example, 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. For example, 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
      FAILED_PRECONDITION = 9;

    • ABORTED

      public static final Code ABORTED
      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
      ABORTED = 10;

    • OUT_OF_RANGE

      public static final Code OUT_OF_RANGE
      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
      OUT_OF_RANGE = 11;

    • UNIMPLEMENTED

      public static final Code UNIMPLEMENTED
      The operation is not implemented or is not supported/enabled in this
service.

HTTP Mapping: 501 Not Implemented
      UNIMPLEMENTED = 12;

    • INTERNAL

      public static final Code INTERNAL
      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
      INTERNAL = 13;

    • UNAVAILABLE

      public static final Code UNAVAILABLE
      The service is currently unavailable.  This is most likely a
transient condition, which can be corrected by retrying with
a backoff. Note that it is not always safe to retry
non-idempotent operations.

See the guidelines above for deciding between `FAILED_PRECONDITION`,
`ABORTED`, and `UNAVAILABLE`.

HTTP Mapping: 503 Service Unavailable
      UNAVAILABLE = 14;

    • DATA_LOSS

      public static final Code DATA_LOSS
      Unrecoverable data loss or corruption.

HTTP Mapping: 500 Internal Server Error
      DATA_LOSS = 15;

    • UNRECOGNIZED

      public static final Code UNRECOGNIZED

  • Field Details

    • OK_VALUE

      public static final int OK_VALUE
      Not an error; returned on success.

HTTP Mapping: 200 OK
      OK = 0;
      See Also:

    • CANCELLED_VALUE

      public static final int CANCELLED_VALUE
      The operation was cancelled, typically by the caller.

HTTP Mapping: 499 Client Closed Request
      CANCELLED = 1;
      See Also:

    • UNKNOWN_VALUE

      public static final int UNKNOWN_VALUE
      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
      UNKNOWN = 2;
      See Also:

    • INVALID_ARGUMENT_VALUE

      public static final int INVALID_ARGUMENT_VALUE
      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
      INVALID_ARGUMENT = 3;
      See Also:

    • DEADLINE_EXCEEDED_VALUE

      public static final int DEADLINE_EXCEEDED_VALUE
      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
      DEADLINE_EXCEEDED = 4;
      See Also:

    • NOT_FOUND_VALUE

      public static final int NOT_FOUND_VALUE
      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 allowlist,
`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
      NOT_FOUND = 5;
      See Also:

    • ALREADY_EXISTS_VALUE

      public static final int ALREADY_EXISTS_VALUE
      The entity that a client attempted to create (e.g., file or directory)
already exists.

HTTP Mapping: 409 Conflict
      ALREADY_EXISTS = 6;
      See Also:

    • 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). This error code does not imply the
request is valid or the requested entity exists or satisfies
other pre-conditions.

HTTP Mapping: 403 Forbidden
      PERMISSION_DENIED = 7;
      See Also:

    • UNAUTHENTICATED_VALUE

      public static final int UNAUTHENTICATED_VALUE
      The request does not have valid authentication credentials for the
operation.

HTTP Mapping: 401 Unauthorized
      UNAUTHENTICATED = 16;
      See Also:

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

HTTP Mapping: 429 Too Many Requests
      RESOURCE_EXHAUSTED = 8;
      See Also:

    • FAILED_PRECONDITION_VALUE

      public static final int FAILED_PRECONDITION_VALUE
      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. For
     example, 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. For example, 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
      FAILED_PRECONDITION = 9;
      See Also:

    • ABORTED_VALUE

      public static final int ABORTED_VALUE
      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
      ABORTED = 10;
      See Also:

    • OUT_OF_RANGE_VALUE

      public static final int OUT_OF_RANGE_VALUE
      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
      OUT_OF_RANGE = 11;
      See Also:

    • UNIMPLEMENTED_VALUE

      public static final int UNIMPLEMENTED_VALUE
      The operation is not implemented or is not supported/enabled in this
service.

HTTP Mapping: 501 Not Implemented
      UNIMPLEMENTED = 12;
      See Also:

    • INTERNAL_VALUE

      public static final int INTERNAL_VALUE
      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
      INTERNAL = 13;
      See Also:

    • UNAVAILABLE_VALUE

      public static final int UNAVAILABLE_VALUE
      The service is currently unavailable.  This is most likely a
transient condition, which can be corrected by retrying with
a backoff. Note that it is not always safe to retry
non-idempotent operations.

See the guidelines above for deciding between `FAILED_PRECONDITION`,
`ABORTED`, and `UNAVAILABLE`.

HTTP Mapping: 503 Service Unavailable
      UNAVAILABLE = 14;
      See Also:

    • DATA_LOSS_VALUE

      public static final int DATA_LOSS_VALUE
      Unrecoverable data loss or corruption.

HTTP Mapping: 500 Internal Server Error
      DATA_LOSS = 15;
      See Also:

  • Method Details

    • values

      public static Code[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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 com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.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 com.google.protobuf.Internal.EnumLiteMap<Code> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static Code valueOf(com.google.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