ClusterBackup.Configuration (Aeron Message Transport)

java.lang.Object
- io.aeron.cluster.ClusterBackup.Configuration

Enclosing class:

ClusterBackup
```
public static class ClusterBackup.Configuration
extends Object
```
Configuration options for ClusterBackup with defaults and constants for system properties lookup.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLUSTER_BACKUP_CATCHUP_CHANNEL_DEFAULT` Default channel template used for catchup and replication of log and snapshots.
`static String`	`CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME` Channel template used for catchup and replication of log and snapshots.
`static String`	`CLUSTER_BACKUP_CATCHUP_ENDPOINT_PROP_NAME` Channel template used for catchup and replication of log and snapshots.
`static long`	`CLUSTER_BACKUP_COOL_DOWN_INTERVAL_DEFAULT_NS` Default interval at which the cluster back is re-initialised after an exception has been thrown.
`static String`	`CLUSTER_BACKUP_COOL_DOWN_INTERVAL_PROP_NAME` Interval at which the cluster backup is re-initialised after an exception has been thrown.
`static long`	`CLUSTER_BACKUP_INTERVAL_DEFAULT_NS` Default interval at which a cluster backup will send backup queries.
`static String`	`CLUSTER_BACKUP_INTERVAL_PROP_NAME` Interval at which a cluster backup will send backup queries.
`static long`	`CLUSTER_BACKUP_PROGRESS_TIMEOUT_DEFAULT_NS` Default timeout within which a cluster backup will expect progress.
`static String`	`CLUSTER_BACKUP_PROGRESS_TIMEOUT_PROP_NAME` Timeout within which a cluster backup will expect progress.
`static long`	`CLUSTER_BACKUP_RESPONSE_TIMEOUT_DEFAULT_NS` Default timeout within which a cluster backup will expect a response from a backup query.
`static String`	`CLUSTER_BACKUP_RESPONSE_TIMEOUT_PROP_NAME` Timeout within which a cluster backup will expect a response from a backup query.
`static String`	`CLUSTER_BACKUP_SOURCE_TYPE_DEFAULT` Default source type to receive log traffic from.
`static String`	`CLUSTER_BACKUP_SOURCE_TYPE_PROP_NAME` The source type used for the cluster backup.

Constructor Summary

Constructors
Constructor and Description

Configuration()

Constructors
Constructor and Description
`Configuration()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`catchupChannel()` The value `CLUSTER_BACKUP_CATCHUP_CHANNEL_DEFAULT` or system property `CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME` if set.
`static String`	`catchupEndpoint()` The value of system property `CLUSTER_BACKUP_CATCHUP_ENDPOINT_PROP_NAME` if set, otherwise it will try to derive the catchup endpoint from `ConsensusModule.Configuration.clusterMembers()` and `ConsensusModule.Configuration.clusterMemberId()`.
`static long`	`clusterBackupCoolDownIntervalNs()` Interval at which the cluster backup is re-initialised after an exception has been thrown.
`static long`	`clusterBackupIntervalNs()` Interval at which a cluster backup will send backup queries.
`static long`	`clusterBackupProgressTimeoutNs()` Timeout within which a cluster backup will expect progress.
`static long`	`clusterBackupResponseTimeoutNs()` Timeout within which a cluster backup will expect a response from a backup query.
`static String`	`clusterBackupSourceType()` Returns the string representation of the `ClusterBackup.SourceType` that this backup instance will use depending on the value of the `CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME` system property if set or `CLUSTER_BACKUP_SOURCE_TYPE_DEFAULT` if not.
`static String`	`consensusChannel()` The value of system property `ConsensusModule.Configuration.consensusChannel()` if set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLUSTER_BACKUP_CATCHUP_ENDPOINT_PROP_NAME
```
public static final String CLUSTER_BACKUP_CATCHUP_ENDPOINT_PROP_NAME
```
    Channel template used for catchup and replication of log and snapshots.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME
```
public static final String CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME
```
    Channel template used for catchup and replication of log and snapshots.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_BACKUP_CATCHUP_CHANNEL_DEFAULT
```
public static final String CLUSTER_BACKUP_CATCHUP_CHANNEL_DEFAULT
```
    Default channel template used for catchup and replication of log and snapshots.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_BACKUP_INTERVAL_PROP_NAME
```
public static final String CLUSTER_BACKUP_INTERVAL_PROP_NAME
```
    Interval at which a cluster backup will send backup queries.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_BACKUP_INTERVAL_DEFAULT_NS
```
public static final long CLUSTER_BACKUP_INTERVAL_DEFAULT_NS
```
    Default interval at which a cluster backup will send backup queries.
  - CLUSTER_BACKUP_RESPONSE_TIMEOUT_PROP_NAME
```
public static final String CLUSTER_BACKUP_RESPONSE_TIMEOUT_PROP_NAME
```
    Timeout within which a cluster backup will expect a response from a backup query.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_BACKUP_RESPONSE_TIMEOUT_DEFAULT_NS
```
public static final long CLUSTER_BACKUP_RESPONSE_TIMEOUT_DEFAULT_NS
```
    Default timeout within which a cluster backup will expect a response from a backup query.
  - CLUSTER_BACKUP_PROGRESS_TIMEOUT_PROP_NAME
```
public static final String CLUSTER_BACKUP_PROGRESS_TIMEOUT_PROP_NAME
```
    Timeout within which a cluster backup will expect progress.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_BACKUP_COOL_DOWN_INTERVAL_PROP_NAME
```
public static final String CLUSTER_BACKUP_COOL_DOWN_INTERVAL_PROP_NAME
```
    Interval at which the cluster backup is re-initialised after an exception has been thrown.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_BACKUP_COOL_DOWN_INTERVAL_DEFAULT_NS
```
public static final long CLUSTER_BACKUP_COOL_DOWN_INTERVAL_DEFAULT_NS
```
    Default interval at which the cluster back is re-initialised after an exception has been thrown.
  - CLUSTER_BACKUP_PROGRESS_TIMEOUT_DEFAULT_NS
```
public static final long CLUSTER_BACKUP_PROGRESS_TIMEOUT_DEFAULT_NS
```
    Default timeout within which a cluster backup will expect progress.
  - CLUSTER_BACKUP_SOURCE_TYPE_PROP_NAME
```
public static final String CLUSTER_BACKUP_SOURCE_TYPE_PROP_NAME
```
    The source type used for the cluster backup. Should match on of the ClusterBackup.SourceType enum values.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_BACKUP_SOURCE_TYPE_DEFAULT
```
public static final String CLUSTER_BACKUP_SOURCE_TYPE_DEFAULT
```
    Default source type to receive log traffic from.
- Constructor Detail
  - Configuration
```
public Configuration()
```
- Method Detail
  - catchupEndpoint
```
public static String catchupEndpoint()
```
    The value of system property CLUSTER_BACKUP_CATCHUP_ENDPOINT_PROP_NAME if set, otherwise it will try to derive the catchup endpoint from ConsensusModule.Configuration.clusterMembers() and ConsensusModule.Configuration.clusterMemberId(). Failing that null will be returned.
    
    Returns:
    
    system property CLUSTER_BACKUP_CATCHUP_ENDPOINT_PROP_NAME, the derived value, or null.
  - catchupChannel
```
public static String catchupChannel()
```
    The value CLUSTER_BACKUP_CATCHUP_CHANNEL_DEFAULT or system property CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME if set.
    
    Returns:
    
    CLUSTER_BACKUP_CATCHUP_CHANNEL_DEFAULT or system property CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME if set.
  - consensusChannel
```
public static String consensusChannel()
```
    The value of system property ConsensusModule.Configuration.consensusChannel() if set. If that channel does not have an endpoint set, then this will try to derive one using ConsensusModule.Configuration.clusterMembers() and ConsensusModule.Configuration.clusterMemberId().
    
    Returns:
    
    system property CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME, the derived value, or null.
  - clusterBackupIntervalNs
```
public static long clusterBackupIntervalNs()
```
    Interval at which a cluster backup will send backup queries.
    
    Returns:
    
    Interval at which a cluster backup will send backup queries.
    
    See Also:
    
    CLUSTER_BACKUP_INTERVAL_PROP_NAME
  - clusterBackupResponseTimeoutNs
```
public static long clusterBackupResponseTimeoutNs()
```
    Timeout within which a cluster backup will expect a response from a backup query.
    
    Returns:
    
    timeout within which a cluster backup will expect a response from a backup query.
    
    See Also:
    
    CLUSTER_BACKUP_RESPONSE_TIMEOUT_PROP_NAME
  - clusterBackupProgressTimeoutNs
```
public static long clusterBackupProgressTimeoutNs()
```
    Timeout within which a cluster backup will expect progress.
    
    Returns:
    
    timeout within which a cluster backup will expect progress.
    
    See Also:
    
    CLUSTER_BACKUP_PROGRESS_TIMEOUT_PROP_NAME
  - clusterBackupCoolDownIntervalNs
```
public static long clusterBackupCoolDownIntervalNs()
```
    Interval at which the cluster backup is re-initialised after an exception has been thrown.
    
    Returns:
    
    interval at which the cluster backup is re-initialised after an exception has been thrown.
    
    See Also:
    
    CLUSTER_BACKUP_COOL_DOWN_INTERVAL_PROP_NAME
  - clusterBackupSourceType
```
public static String clusterBackupSourceType()
```
    Returns the string representation of the ClusterBackup.SourceType that this backup instance will use depending on the value of the CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME system property if set or CLUSTER_BACKUP_SOURCE_TYPE_DEFAULT if not.
    
    Returns:
    
    the configured source type.

Class ClusterBackup.Configuration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLUSTER_BACKUP_CATCHUP_ENDPOINT_PROP_NAME

CLUSTER_BACKUP_CATCHUP_CHANNEL_PROP_NAME

CLUSTER_BACKUP_CATCHUP_CHANNEL_DEFAULT

CLUSTER_BACKUP_INTERVAL_PROP_NAME

CLUSTER_BACKUP_INTERVAL_DEFAULT_NS

CLUSTER_BACKUP_RESPONSE_TIMEOUT_PROP_NAME

CLUSTER_BACKUP_RESPONSE_TIMEOUT_DEFAULT_NS

CLUSTER_BACKUP_PROGRESS_TIMEOUT_PROP_NAME

CLUSTER_BACKUP_COOL_DOWN_INTERVAL_PROP_NAME

CLUSTER_BACKUP_COOL_DOWN_INTERVAL_DEFAULT_NS

CLUSTER_BACKUP_PROGRESS_TIMEOUT_DEFAULT_NS

CLUSTER_BACKUP_SOURCE_TYPE_PROP_NAME

CLUSTER_BACKUP_SOURCE_TYPE_DEFAULT

Constructor Detail

Configuration

Method Detail

catchupEndpoint

catchupChannel

consensusChannel

clusterBackupIntervalNs

clusterBackupResponseTimeoutNs

clusterBackupProgressTimeoutNs

clusterBackupCoolDownIntervalNs

clusterBackupSourceType