Package org.opensearch.indices

Class RemoteStoreSettings

java.lang.Object
org.opensearch.indices.RemoteStoreSettings
@PublicApi(since="2.14.0") public class RemoteStoreSettings extends Object
Settings for remote store
Opensearch.api:

  • Field Details

    • CLUSTER_REMOTE_TRANSLOG_BUFFER_INTERVAL_SETTING

      public static final Setting<org.opensearch.common.unit.TimeValue> CLUSTER_REMOTE_TRANSLOG_BUFFER_INTERVAL_SETTING
      Used to specify the default translog buffer interval for remote store backed indexes.

    • CLUSTER_REMOTE_INDEX_SEGMENT_METADATA_RETENTION_MAX_COUNT_SETTING

      public static final Setting<Integer> CLUSTER_REMOTE_INDEX_SEGMENT_METADATA_RETENTION_MAX_COUNT_SETTING
      Controls minimum number of metadata files to keep in remote segment store. value < 1 will disable deletion of stale segment metadata files.

    • CLUSTER_REMOTE_TRANSLOG_TRANSFER_TIMEOUT_SETTING

      public static final Setting<org.opensearch.common.unit.TimeValue> CLUSTER_REMOTE_TRANSLOG_TRANSFER_TIMEOUT_SETTING
      Controls timeout value while uploading translog and checkpoint files to remote translog

    • CLUSTER_REMOTE_STORE_PATH_TYPE_SETTING

      @ExperimentalApi public static final Setting<RemoteStoreEnums.PathType> CLUSTER_REMOTE_STORE_PATH_TYPE_SETTING
      This setting is used to set the remote store blob store path type strategy. This setting is effective only for remote store enabled cluster.

    • CLUSTER_REMOTE_STORE_PATH_HASH_ALGORITHM_SETTING

      @ExperimentalApi public static final Setting<RemoteStoreEnums.PathHashAlgorithm> CLUSTER_REMOTE_STORE_PATH_HASH_ALGORITHM_SETTING
      This setting is used to set the remote store blob store path hash algorithm strategy. This setting is effective only for remote store enabled cluster. This setting will come to effect if the CLUSTER_REMOTE_STORE_PATH_TYPE_SETTING is either HASHED_PREFIX or HASHED_INFIX.

    • CLUSTER_REMOTE_MAX_TRANSLOG_READERS

      public static final Setting<Integer> CLUSTER_REMOTE_MAX_TRANSLOG_READERS
      Controls the maximum referenced remote translog files. If breached the shard will be flushed.

  • Constructor Details

  • Method Details

    • getClusterRemoteTranslogBufferInterval

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

    • getMinRemoteSegmentMetadataFiles

      public int getMinRemoteSegmentMetadataFiles()

    • getClusterRemoteTranslogTransferTimeout

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

    • getPathType

      @ExperimentalApi public RemoteStoreEnums.PathType getPathType()

    • getPathHashAlgorithm

      @ExperimentalApi public RemoteStoreEnums.PathHashAlgorithm getPathHashAlgorithm()

    • getMaxRemoteTranslogReaders

      public int getMaxRemoteTranslogReaders()