Package org.opensearch.indices.recovery

Class RecoverySettings

java.lang.Object
org.opensearch.indices.recovery.RecoverySettings
@PublicApi(since="1.0.0") public class RecoverySettings extends Object
Settings for the recovery mechanism
Opensearch.api:

  • Field Details

    • INDICES_RECOVERY_MAX_BYTES_PER_SEC_SETTING

      public static final Setting<org.opensearch.core.common.unit.ByteSizeValue> INDICES_RECOVERY_MAX_BYTES_PER_SEC_SETTING

    • INDICES_REPLICATION_MAX_BYTES_PER_SEC_SETTING

      public static final Setting<org.opensearch.core.common.unit.ByteSizeValue> INDICES_REPLICATION_MAX_BYTES_PER_SEC_SETTING
      Individual speed setting for segment replication, default -1B to reuse the setting of recovery.

    • INDICES_RECOVERY_MAX_CONCURRENT_FILE_CHUNKS_SETTING

      public static final Setting<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<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_MAX_CONCURRENT_REMOTE_STORE_STREAMS_SETTING

      public static final Setting<Integer> INDICES_RECOVERY_MAX_CONCURRENT_REMOTE_STORE_STREAMS_SETTING
      Controls the maximum number of streams that can be started concurrently per recovery when downloading from the remote store.

    • 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`

    • INDICES_INTERNAL_REMOTE_UPLOAD_TIMEOUT

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

    • DEFAULT_CHUNK_SIZE

      public static final org.opensearch.core.common.unit.ByteSizeValue DEFAULT_CHUNK_SIZE

    • INDICES_RECOVERY_CHUNK_SIZE_SETTING

      public static final Setting<org.opensearch.core.common.unit.ByteSizeValue> INDICES_RECOVERY_CHUNK_SIZE_SETTING

  • Constructor Details

  • Method Details

    • rateLimiter

      @Deprecated(forRemoval=true, since="2.14") public org.apache.lucene.store.RateLimiter rateLimiter()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Method unused as of 2.14 but left as part of public API. Use recoveryRateLimiter or replicationRateLimiter instead.
      Returns:
      RateLimiter Recovery rate limiter

    • recoveryRateLimiter

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

    • replicationRateLimiter

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

    • 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()

    • internalRemoteUploadTimeout

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

    • getChunkSize

      public org.opensearch.core.common.unit.ByteSizeValue getChunkSize()

    • setChunkSize

      public void setChunkSize(org.opensearch.core.common.unit.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)

    • setInternalRemoteUploadTimeout

      public void setInternalRemoteUploadTimeout(org.opensearch.common.unit.TimeValue internalRemoteUploadTimeout)

    • setInternalActionRetryTimeout

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

    • getMaxConcurrentFileChunks

      public int getMaxConcurrentFileChunks()

    • getMaxConcurrentOperations

      public int getMaxConcurrentOperations()

    • getMaxConcurrentRemoteStoreStreams

      public int getMaxConcurrentRemoteStoreStreams()