Package org.opensearch.indices.recovery

Class RecoverySettings

java.lang.Object

org.opensearch.indices.recovery.RecoverySettings

public class RecoverySettings
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static ByteSizeValue	DEFAULT_CHUNK_SIZE
static Setting<org.opensearch.common.unit.TimeValue>	INDICES_RECOVERY_ACTIVITY_TIMEOUT_SETTING	recoveries that don't show any activity for more then this interval will be failed.
static Setting<org.opensearch.common.unit.TimeValue>	INDICES_RECOVERY_INTERNAL_ACTION_RETRY_TIMEOUT_SETTING	timeout value to use for the retrying of requests made as part of the recovery process
static Setting<org.opensearch.common.unit.TimeValue>	INDICES_RECOVERY_INTERNAL_ACTION_TIMEOUT_SETTING	timeout value to use for requests made as part of the recovery process
static Setting<org.opensearch.common.unit.TimeValue>	INDICES_RECOVERY_INTERNAL_LONG_ACTION_TIMEOUT_SETTING	timeout value to use for requests made as part of the recovery process that are expected to take long time.
static Setting<ByteSizeValue>	INDICES_RECOVERY_MAX_BYTES_PER_SEC_SETTING
static Setting<java.lang.Integer>	INDICES_RECOVERY_MAX_CONCURRENT_FILE_CHUNKS_SETTING	Controls the maximum number of file chunk requests that can be sent concurrently from the source node to the target node.
static Setting<java.lang.Integer>	INDICES_RECOVERY_MAX_CONCURRENT_OPERATIONS_SETTING	Controls the maximum number of operation chunk requests that can be sent concurrently from the source node to the target node.
static Setting<org.opensearch.common.unit.TimeValue>	INDICES_RECOVERY_RETRY_DELAY_NETWORK_SETTING	how long to wait before retrying after network related issues
static Setting<org.opensearch.common.unit.TimeValue>	INDICES_RECOVERY_RETRY_DELAY_STATE_SYNC_SETTING	how long to wait before retrying after issues cause by cluster state syncing between nodes i.e., local node is not yet known on remote node, remote shard not yet started etc.

Constructor Summary

Constructors

Constructor	Description
RecoverySettings(Settings settings, ClusterSettings clusterSettings)

Method Summary

Modifier and Type	Method	Description
org.opensearch.common.unit.TimeValue	activityTimeout()
ByteSizeValue	getChunkSize()
int	getMaxConcurrentFileChunks()
int	getMaxConcurrentOperations()
org.opensearch.common.unit.TimeValue	internalActionLongTimeout()
org.opensearch.common.unit.TimeValue	internalActionRetryTimeout()
org.opensearch.common.unit.TimeValue	internalActionTimeout()
org.apache.lucene.store.RateLimiter	rateLimiter()
org.opensearch.common.unit.TimeValue	retryDelayNetwork()
org.opensearch.common.unit.TimeValue	retryDelayStateSync()
void	setActivityTimeout(org.opensearch.common.unit.TimeValue activityTimeout)
void	setChunkSize(ByteSizeValue chunkSize)
void	setInternalActionLongTimeout(org.opensearch.common.unit.TimeValue internalActionLongTimeout)
void	setInternalActionTimeout(org.opensearch.common.unit.TimeValue internalActionTimeout)
void	setRetryDelayNetwork(org.opensearch.common.unit.TimeValue retryDelayNetwork)
void	setRetryDelayStateSync(org.opensearch.common.unit.TimeValue retryDelayStateSync)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INDICES_RECOVERY_MAX_BYTES_PER_SEC_SETTING

public static final Setting<ByteSizeValue> INDICES_RECOVERY_MAX_BYTES_PER_SEC_SETTING

INDICES_RECOVERY_MAX_CONCURRENT_FILE_CHUNKS_SETTING

public static final Setting<java.lang.Integer> INDICES_RECOVERY_MAX_CONCURRENT_FILE_CHUNKS_SETTING

Controls the maximum number of file chunk requests that can be sent concurrently from the source node to the target node.

INDICES_RECOVERY_MAX_CONCURRENT_OPERATIONS_SETTING

public static final Setting<java.lang.Integer> INDICES_RECOVERY_MAX_CONCURRENT_OPERATIONS_SETTING

Controls the maximum number of operation chunk requests that can be sent concurrently from the source node to the target node.

INDICES_RECOVERY_RETRY_DELAY_STATE_SYNC_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> INDICES_RECOVERY_RETRY_DELAY_STATE_SYNC_SETTING

how long to wait before retrying after issues cause by cluster state syncing between nodes i.e., local node is not yet known on remote node, remote shard not yet started etc.

INDICES_RECOVERY_RETRY_DELAY_NETWORK_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> INDICES_RECOVERY_RETRY_DELAY_NETWORK_SETTING

how long to wait before retrying after network related issues

INDICES_RECOVERY_INTERNAL_ACTION_TIMEOUT_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> INDICES_RECOVERY_INTERNAL_ACTION_TIMEOUT_SETTING

timeout value to use for requests made as part of the recovery process

INDICES_RECOVERY_INTERNAL_ACTION_RETRY_TIMEOUT_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> INDICES_RECOVERY_INTERNAL_ACTION_RETRY_TIMEOUT_SETTING

timeout value to use for the retrying of requests made as part of the recovery process

INDICES_RECOVERY_INTERNAL_LONG_ACTION_TIMEOUT_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> INDICES_RECOVERY_INTERNAL_LONG_ACTION_TIMEOUT_SETTING

timeout value to use for requests made as part of the recovery process that are expected to take long time. defaults to twice `indices.recovery.internal_action_timeout`.

INDICES_RECOVERY_ACTIVITY_TIMEOUT_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> INDICES_RECOVERY_ACTIVITY_TIMEOUT_SETTING

recoveries that don't show any activity for more then this interval will be failed. defaults to `indices.recovery.internal_action_long_timeout`

DEFAULT_CHUNK_SIZE

public static final ByteSizeValue DEFAULT_CHUNK_SIZE

Constructor Details

RecoverySettings

public RecoverySettings(Settings settings, ClusterSettings clusterSettings)

Method Details

rateLimiter

public org.apache.lucene.store.RateLimiter rateLimiter()

retryDelayNetwork

public org.opensearch.common.unit.TimeValue retryDelayNetwork()

retryDelayStateSync

public org.opensearch.common.unit.TimeValue retryDelayStateSync()

activityTimeout

public org.opensearch.common.unit.TimeValue activityTimeout()

internalActionTimeout

public org.opensearch.common.unit.TimeValue internalActionTimeout()

internalActionRetryTimeout

public org.opensearch.common.unit.TimeValue internalActionRetryTimeout()

internalActionLongTimeout

public org.opensearch.common.unit.TimeValue internalActionLongTimeout()

getChunkSize

public ByteSizeValue getChunkSize()

setChunkSize

public void setChunkSize(ByteSizeValue chunkSize)

setRetryDelayStateSync

public void setRetryDelayStateSync(org.opensearch.common.unit.TimeValue retryDelayStateSync)

setRetryDelayNetwork

public void setRetryDelayNetwork(org.opensearch.common.unit.TimeValue retryDelayNetwork)

setActivityTimeout

public void setActivityTimeout(org.opensearch.common.unit.TimeValue activityTimeout)

setInternalActionTimeout

public void setInternalActionTimeout(org.opensearch.common.unit.TimeValue internalActionTimeout)

setInternalActionLongTimeout

public void setInternalActionLongTimeout(org.opensearch.common.unit.TimeValue internalActionLongTimeout)

getMaxConcurrentFileChunks

public int getMaxConcurrentFileChunks()

getMaxConcurrentOperations

public int getMaxConcurrentOperations()