Package co.elastic.clients.elasticsearch.snapshot

Class RepositorySettingsBase.AbstractBuilder<BuilderT extends RepositorySettingsBase.AbstractBuilder<BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase.AbstractBuilder<BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
AzureRepositorySettings.Builder, GcsRepositorySettings.Builder, ReadOnlyUrlRepositorySettings.Builder, S3RepositorySettings.Builder, SharedFileSystemRepositorySettings.Builder, SourceOnlyRepositorySettings.Builder
Enclosing class:
RepositorySettingsBase
public abstract static class RepositorySettingsBase.AbstractBuilder<BuilderT extends RepositorySettingsBase.AbstractBuilder<BuilderT>> extends WithJsonObjectBuilderBase<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • chunkSize

      public final BuilderT chunkSize(@Nullable String value)
      Big files can be broken down into multiple smaller blobs in the blob store during snapshotting. It is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository. Setting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly. Specify the chunk size as a byte unit, for example: 10MB, 5KB, 500B. The default varies by repository type.

      API name: chunk_size

    • compress

      public final BuilderT compress(@Nullable Boolean value)
      When set to true, metadata files are stored in compressed format. This setting doesn't affect index files that are already compressed by default.

      API name: compress

    • maxRestoreBytesPerSec

      public final BuilderT maxRestoreBytesPerSec(@Nullable String value)
      The maximum snapshot restore rate per node. It defaults to unlimited. Note that restores are also throttled through recovery settings.

      API name: max_restore_bytes_per_sec

    • maxSnapshotBytesPerSec

      public final BuilderT maxSnapshotBytesPerSec(@Nullable String value)
      The maximum snapshot creation rate per node. It defaults to 40mb per second. Note that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings.

      API name: max_snapshot_bytes_per_sec

    • self

      protected abstract BuilderT self()
      Specified by:
      self in class WithJsonObjectBuilderBase<BuilderT extends RepositorySettingsBase.AbstractBuilder<BuilderT>>