GrpcStatusCode (servicetalk-grpc-api 0.42.37 API)

Object
- Enum<GrpcStatusCode>
- - GrpcStatusCode

All Implemented Interfaces:

Serializable, Comparable<GrpcStatusCode>
```
public enum GrpcStatusCode
extends Enum<GrpcStatusCode>
```
Standard gRPC status codes.

See Also:

Official gRPC status codes, Status codes and their use in gRPC

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABORTED` Aborted, typically due to a concurrency issue (think CAS).
`ALREADY_EXISTS` Some entity that we attempted to create already exists.
`CANCELLED` Cancelled (typically by caller).
`DATA_LOSS` Data corruption.
`DEADLINE_EXCEEDED` Deadline expired.
`FAILED_PRECONDITION` The action cannot be executed on the current system state.
`INTERNAL` Internal invariant violated.
`INVALID_ARGUMENT` Client specified an invalid argument.
`NOT_FOUND` Some requested entity not found.
`OK` Successful.
`OUT_OF_RANGE` Used for range errors (e.g.
`PERMISSION_DENIED` Permission denied for a particular client.
`RESOURCE_EXHAUSTED` Resource exhausted.
`UNAUTHENTICATED` Cannot authenticate the client.
`UNAVAILABLE` Service unavailable, similar to 503, client may retry.
`UNIMPLEMENTED` The method/operation is not implemented/supported.
`UNKNOWN` Unknown error.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GrpcStatusCode`	`fromCodeValue(CharSequence codeValue)` Obtains the status code given a code value.
`static GrpcStatusCode`	`fromCodeValue(int codeValue)` Obtains the status code given an integer code value.
`static GrpcStatusCode`	`fromHttp2ErrorCode(Http2ErrorCode errorCode)` Convert from `Http2ErrorCode` to `GrpcStatus`.
`GrpcStatus`	`status()` Returns a standard `GrpcStatus` with this status code.
`int`	`value()` Returns the integer code value.
`static GrpcStatusCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static GrpcStatusCode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - OK
```
public static final GrpcStatusCode OK
```
    Successful.
  - CANCELLED
```
public static final GrpcStatusCode CANCELLED
```
    Cancelled (typically by caller).
  - UNKNOWN
```
public static final GrpcStatusCode UNKNOWN
```
    Unknown error.
  - INVALID_ARGUMENT
```
public static final GrpcStatusCode INVALID_ARGUMENT
```
    Client specified an invalid argument.
  - DEADLINE_EXCEEDED
```
public static final GrpcStatusCode DEADLINE_EXCEEDED
```
    Deadline expired.
  - NOT_FOUND
```
public static final GrpcStatusCode NOT_FOUND
```
    Some requested entity not found.
  - ALREADY_EXISTS
```
public static final GrpcStatusCode ALREADY_EXISTS
```
    Some entity that we attempted to create already exists.
  - PERMISSION_DENIED
```
public static final GrpcStatusCode PERMISSION_DENIED
```
    Permission denied for a particular client. Must not be used for the following cases:
    - rejections caused by exhausting some resource (use RESOURCE_EXHAUSTED instead)
    - the caller cannot be identified (use UNAUTHENTICATED instead)
  - RESOURCE_EXHAUSTED
```
public static final GrpcStatusCode RESOURCE_EXHAUSTED
```
    Resource exhausted.
  - FAILED_PRECONDITION
```
public static final GrpcStatusCode FAILED_PRECONDITION
```
    The action cannot be executed on the current system state. Client should not retry.
  - ABORTED
```
public static final GrpcStatusCode ABORTED
```
    Aborted, typically due to a concurrency issue (think CAS). Client may retry the whole sequence.
  - OUT_OF_RANGE
```
public static final GrpcStatusCode OUT_OF_RANGE
```
    Used for range errors (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 with FAILED_PRECONDITION. This error is more specific and recommended in scenarios when 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 GrpcStatusCode UNIMPLEMENTED
```
    The method/operation is not implemented/supported.
  - INTERNAL
```
public static final GrpcStatusCode INTERNAL
```
    Internal invariant violated.
  - UNAVAILABLE
```
public static final GrpcStatusCode UNAVAILABLE
```
    Service unavailable, similar to 503, client may retry.
  - DATA_LOSS
```
public static final GrpcStatusCode DATA_LOSS
```
    Data corruption.
  - UNAUTHENTICATED
```
public static final GrpcStatusCode UNAUTHENTICATED
```
    Cannot authenticate the client.
- Method Detail
  - values
```
public static GrpcStatusCode[] 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 (GrpcStatusCode c : GrpcStatusCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GrpcStatusCode 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
  - fromCodeValue
```
public static GrpcStatusCode fromCodeValue(CharSequence codeValue)
```
    Obtains the status code given a code value.
    
    Parameters:
    
    codeValue - code value.
    
    Returns:
    
    status code associated with the code value, or UNKNOWN.
  - fromCodeValue
```
public static GrpcStatusCode fromCodeValue(int codeValue)
```
    Obtains the status code given an integer code value.
    
    Parameters:
    
    codeValue - integer code value.
    
    Returns:
    
    status code associated with the code value, or UNKNOWN.
  - value
```
public int value()
```
    Returns the integer code value.
    
    Returns:
    
    the integer code value.
  - status
```
public GrpcStatus status()
```
    Returns a standard GrpcStatus with this status code.
    
    Returns:
    
    a standard GrpcStatus with this status code.
  - fromHttp2ErrorCode
```
public static GrpcStatusCode fromHttp2ErrorCode(Http2ErrorCode errorCode)
```
    Convert from Http2ErrorCode to GrpcStatus.
    
    Parameters:
    
    errorCode - the Http2ErrorCode to convert.
    
    Returns:
    
    the result of the conversion.

Enum GrpcStatusCode

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

OK

CANCELLED

UNKNOWN

INVALID_ARGUMENT

DEADLINE_EXCEEDED

NOT_FOUND

ALREADY_EXISTS

PERMISSION_DENIED

RESOURCE_EXHAUSTED

FAILED_PRECONDITION

ABORTED

OUT_OF_RANGE

UNIMPLEMENTED

INTERNAL

UNAVAILABLE

DATA_LOSS

UNAUTHENTICATED

Method Detail

values

valueOf

fromCodeValue

fromCodeValue

value

status

fromHttp2ErrorCode