io.greptime

Enum Status

java.lang.Object

java.lang.Enum<Status>

io.greptime.Status

All Implemented Interfaces:

Serializable, Comparable<Status>

public enum Status
extends Enum<Status>

Common status code for public API.

Always follow GreptimeDB's STATUS CODE

Enum Constant Summary

Enum Constants

Enum Constant and Description
AccessDenied
AuthHeaderNotFound
Cancelled
DatabaseAlreadyExists
DatabaseNotFound
EngineExecuteQuery
External
IllegalState
Internal
InvalidArguments
InvalidAuthHeader
InvalidSyntax
PermissionDenied
PlanQuery
RateLimited
RegionAlreadyExists
RegionBusy
RegionNotFound
RegionNotReady
RegionReadonly
RequestOutdated
RuntimeResourcesExhausted
StorageUnavailable
Success
TableAlreadyExists
TableColumnExists
TableColumnNotFound
TableNotFound
TableUnavailable
Unexpected
Unknown
Unsupported
UnsupportedPasswordType
UserNotFound
UserPasswordMismatch

Method Summary

Modifier and Type	Method and Description
int	getStatusCode() Gets the status code.
boolean	isShouldRetry() Checks if the status code represents a retry-needed error.
static boolean	isSuccess(int statusCode) Checks if the status code is Success.
static Status	parse(int statusCode) Gets the Status for the specified status code.
static Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static Status[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Success

public static final Status Success

Unknown

public static final Status Unknown

Unsupported

public static final Status Unsupported

Unexpected

public static final Status Unexpected

Internal

public static final Status Internal

InvalidArguments

public static final Status InvalidArguments

Cancelled

public static final Status Cancelled

IllegalState

public static final Status IllegalState

External

public static final Status External

InvalidSyntax

public static final Status InvalidSyntax

PlanQuery

public static final Status PlanQuery

EngineExecuteQuery

public static final Status EngineExecuteQuery

TableAlreadyExists

public static final Status TableAlreadyExists

TableNotFound

public static final Status TableNotFound

TableColumnNotFound

public static final Status TableColumnNotFound

TableColumnExists

public static final Status TableColumnExists

DatabaseNotFound

public static final Status DatabaseNotFound

RegionNotFound

public static final Status RegionNotFound

RegionAlreadyExists

public static final Status RegionAlreadyExists

RegionReadonly

public static final Status RegionReadonly

RegionNotReady

public static final Status RegionNotReady

RegionBusy

public static final Status RegionBusy

TableUnavailable

public static final Status TableUnavailable

DatabaseAlreadyExists

public static final Status DatabaseAlreadyExists

StorageUnavailable

public static final Status StorageUnavailable

RequestOutdated

public static final Status RequestOutdated

RuntimeResourcesExhausted

public static final Status RuntimeResourcesExhausted

RateLimited

public static final Status RateLimited

UserNotFound

public static final Status UserNotFound

UnsupportedPasswordType

public static final Status UnsupportedPasswordType

UserPasswordMismatch

public static final Status UserPasswordMismatch

AuthHeaderNotFound

public static final Status AuthHeaderNotFound

InvalidAuthHeader

public static final Status InvalidAuthHeader

AccessDenied

public static final Status AccessDenied

PermissionDenied

public static final Status PermissionDenied

Method Detail

values

public static Status[] 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 (Status c : Status.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Status 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

getStatusCode

public int getStatusCode()

Gets the status code.

Returns:

the status code

isSuccess

public static boolean isSuccess(int statusCode)

Checks if the status code is Success.

Parameters:

statusCode - the status code

Returns:

true if the status code is Success

isShouldRetry

public boolean isShouldRetry()

Checks if the status code represents a retry-needed error.

Returns:

true if the status code represents a retry-needed error

parse

public static Status parse(int statusCode)

Gets the Status for the specified status code.

Parameters:

statusCode - the status code

Returns:

the Status