Module io.inverno.mod.grpc.base
Package io.inverno.mod.grpc.base

Enum Class GrpcStatus

java.lang.Object
java.lang.Enum<GrpcStatus>
io.inverno.mod.grpc.base.GrpcStatus
All Implemented Interfaces:
Serializable, Comparable<GrpcStatus>, Constable
public enum GrpcStatus extends Enum<GrpcStatus>

Enumeration of gRPC statuses as defined by gRPC Status Codes.

Since:
1.9
Author:
Jeremy Kuhn

  • Enum Constant Details

    • OK

      public static final GrpcStatus OK

      Not an error; returned on success.

    • CANCELLED

      public static final GrpcStatus CANCELLED

      The operation was cancelled, typically by the caller.

    • UNKNOWN

      public static final GrpcStatus 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.

    • INVALID_ARGUMENT

      public static final GrpcStatus 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).

    • DEADLINE_EXCEEDED

      public static final GrpcStatus 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.

    • NOT_FOUND

      public static final GrpcStatus 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.

    • ALREADY_EXISTS

      public static final GrpcStatus ALREADY_EXISTS

      The entity that a client attempted to create (e.g., file or directory) already exists.

    • PERMISSION_DENIED

      public static final GrpcStatus 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.

    • RESOURCE_EXHAUSTED

      public static final GrpcStatus RESOURCE_EXHAUSTED

      Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.

    • FAILED_PRECONDITION

      public static final GrpcStatus 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:

      • Use UNAVAILABLE if the client can retry just the failing call.
      • 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).
      • 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.

    • ABORTED

      public static final GrpcStatus 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.

    • OUT_OF_RANGE

      public static final GrpcStatus 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.

    • UNIMPLEMENTED

      public static final GrpcStatus UNIMPLEMENTED

      The operation is not implemented or is not supported/enabled in this service.

    • INTERNAL

      public static final GrpcStatus INTERNAL

      Internal errors.

      This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors.

    • UNAVAILABLE

      public static final GrpcStatus 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.

    • DATA_LOSS

      public static final GrpcStatus DATA_LOSS

      Unrecoverable data loss or corruption.

    • UNAUTHENTICATED

      public static final GrpcStatus UNAUTHENTICATED

      The request does not have valid authentication credentials for the operation.

  • Method Details

    • values

      public static GrpcStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GrpcStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getCode

      public int getCode()

      Returns the gRPC status code.

      Returns:
      the gRPC status code

    • valueOf

      public static GrpcStatus valueOf(int code) throws IllegalArgumentException

      Returns the gRPC status corresponding to the specified code.

      Parameters:
      code - a gRPC status code
      Returns:
      a gRPC status
      Throws:
      IllegalArgumentException - if the specified status doesn't correspond to a known gRPC status

    • fromHttp2Code

      public static GrpcStatus fromHttp2Code(long code)

      Maps an HTTP/2 Error code to a gRPC status as defined by the gRPC protocol.

      Parameters:
      code - an HTTP/2 error code
      Returns:
      a gRPC status or null if no mapping exists