io.aeron.cluster

Enum ClusterBackup.State

java.lang.Object

java.lang.Enum<ClusterBackup.State>

io.aeron.cluster.ClusterBackup.State

All Implemented Interfaces:

Serializable, Comparable<ClusterBackup.State>

Enclosing class:

ClusterBackup

public static enum ClusterBackup.State
extends Enum<ClusterBackup.State>

State of the cluster backup state machine.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKING_UP Back up live log and track progress until next query deadline is reached.
BACKUP_QUERY Query leader for current status for backup.
CLOSED The backup is complete and closed.
LIVE_LOG_RECORD Setup recording for live log.
LIVE_LOG_REPLAY Replay the current live log since snapshot and join it.
RESET_BACKUP On error or progress stall the backup is reset and started over again.
SNAPSHOT_RETRIEVE Retrieve a copy of the latest snapshot from the leader.
UPDATE_RECORDING_LOG Update the local RecordingLog for recovery.

Method Summary

Modifier and Type	Method and Description
int	code() Code which represents the ClusterBackup.State as an int.
static ClusterBackup.State	get(AtomicCounter counter) Get the ClusterBackup.State encoded in an AtomicCounter.
static ClusterBackup.State	get(long code) Get the ClusterBackup.State with matching code().
static ClusterBackup.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClusterBackup.State[]	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

BACKUP_QUERY

public static final ClusterBackup.State BACKUP_QUERY

Query leader for current status for backup.

SNAPSHOT_RETRIEVE

public static final ClusterBackup.State SNAPSHOT_RETRIEVE

Retrieve a copy of the latest snapshot from the leader.

LIVE_LOG_RECORD

public static final ClusterBackup.State LIVE_LOG_RECORD

Setup recording for live log.

LIVE_LOG_REPLAY

public static final ClusterBackup.State LIVE_LOG_REPLAY

Replay the current live log since snapshot and join it.

UPDATE_RECORDING_LOG

public static final ClusterBackup.State UPDATE_RECORDING_LOG

Update the local RecordingLog for recovery.

BACKING_UP

public static final ClusterBackup.State BACKING_UP

Back up live log and track progress until next query deadline is reached.

RESET_BACKUP

public static final ClusterBackup.State RESET_BACKUP

On error or progress stall the backup is reset and started over again.

CLOSED

public static final ClusterBackup.State CLOSED

The backup is complete and closed.

Method Detail

values

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

Returns:

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

valueOf

public static ClusterBackup.State 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

code

public int code()

Code which represents the ClusterBackup.State as an int.

Returns:

code which represents the ClusterBackup.State as an int.

get

public static ClusterBackup.State get(AtomicCounter counter)

Get the ClusterBackup.State encoded in an AtomicCounter.

Parameters:

counter - to get the current state for.

Returns:

the state for the ClusterBackup.

Throws:

ClusterException - if the counter is not one of the valid values.

get

public static ClusterBackup.State get(long code)

Get the ClusterBackup.State with matching code().

Parameters:

code - to lookup.

Returns:

the ClusterBackup.State matching code().