Package org.apache.polaris.persistence.nosql.realms.api

Enum Class RealmDefinition.RealmStatus

java.lang.Object

java.lang.Enum<RealmDefinition.RealmStatus>

org.apache.polaris.persistence.nosql.realms.api.RealmDefinition.RealmStatus

All Implemented Interfaces:

Serializable, Comparable<RealmDefinition.RealmStatus>, Constable

Enclosing interface:

RealmDefinition

public static enum RealmDefinition.RealmStatus
extends Enum<RealmDefinition.RealmStatus>

Realms are assigned

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	When a realm is fully set up, its state is "active".
CREATED	The initial state of a realm is "created", which means that the realm ID is reserved, but the realm is not yet usable.
INACTIVE	An ACTIVE realm can be put into "inactive" state, which means that the realm cannot be used, but it can be put back into ACTIVE state.
INITIALIZING	State used to indicate that the realm is being initialized.
LOADING	State used to indicate that the realm data is being imported.
PURGED	"Purged" is the terminal state of every realm.
PURGING	An INACTIVE realm can be put into "purging" state, which means that the realm's data is being purged from the persistence database.

Method Summary

Modifier and Type	Method	Description
static RealmDefinition.RealmStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RealmDefinition.RealmStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CREATED

public static final RealmDefinition.RealmStatus CREATED

The initial state of a realm is "created", which means that the realm ID is reserved, but the realm is not yet usable. This state can transition to LOADING or INITIALIZING or the realm can be directly deleted.

LOADING

public static final RealmDefinition.RealmStatus LOADING

State used to indicate that the realm data is being imported. This state can transition to ACTIVE or INACTIVE or PURGING.

INITIALIZING

public static final RealmDefinition.RealmStatus INITIALIZING

State used to indicate that the realm is being initialized. This state can transition to ACTIVE or INACTIVE or PURGING.

ACTIVE

public static final RealmDefinition.RealmStatus ACTIVE

When a realm is fully set up, its state is "active". This state can only transition to INACTIVE.

INACTIVE

public static final RealmDefinition.RealmStatus INACTIVE

An ACTIVE realm can be put into "inactive" state, which means that the realm cannot be used, but it can be put back into ACTIVE state.

PURGING

public static final RealmDefinition.RealmStatus PURGING

An INACTIVE realm can be put into "purging" state, which means that the realm's data is being purged from the persistence database. This is next to the final and terminal state PURGED of a realm. Once all data of the realm has been purged, it must at least be set into PURGED status or be entirely removed.

PURGED

public static final RealmDefinition.RealmStatus PURGED

"Purged" is the terminal state of every realm. A purged realm can be safely deleted. The difference between a "purged" realm and a non-existing (deleted) realm is that the ID of a purged realm cannot be (re)used.

Method Details

values

public static RealmDefinition.RealmStatus[] 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 RealmDefinition.RealmStatus 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