ClusterBackup.State (Aeron Message Transport)

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`
`BACKUP_QUERY`
`INIT`
`LIVE_LOG_REPLAY`
`RESET_BACKUP`
`SNAPSHOT_LENGTH_RETRIEVE`
`SNAPSHOT_RETRIEVE`
`UPDATE_RECORDING_LOG`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`code()` Code which represents the `ClusterBackup.State` as an int.
`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
  - INIT
```
public static final ClusterBackup.State INIT
```
  - BACKUP_QUERY
```
public static final ClusterBackup.State BACKUP_QUERY
```
  - SNAPSHOT_LENGTH_RETRIEVE
```
public static final ClusterBackup.State SNAPSHOT_LENGTH_RETRIEVE
```
  - SNAPSHOT_RETRIEVE
```
public static final ClusterBackup.State SNAPSHOT_RETRIEVE
```
  - LIVE_LOG_REPLAY
```
public static final ClusterBackup.State LIVE_LOG_REPLAY
```
  - UPDATE_RECORDING_LOG
```
public static final ClusterBackup.State UPDATE_RECORDING_LOG
```
  - RESET_BACKUP
```
public static final ClusterBackup.State RESET_BACKUP
```
  - BACKING_UP
```
public static final ClusterBackup.State BACKING_UP
```
- 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(long code)
```
    Get the ClusterBackup.State with matching code().
    
    Parameters:
    
    code - to lookup.
    
    Returns:
    
    the ClusterBackup.State with matching code().

Enum ClusterBackup.State

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INIT

BACKUP_QUERY

SNAPSHOT_LENGTH_RETRIEVE

SNAPSHOT_RETRIEVE

LIVE_LOG_REPLAY

UPDATE_RECORDING_LOG

RESET_BACKUP

BACKING_UP

Method Detail

values

valueOf

code

get