Package co.elastic.clients.elasticsearch.snapshot

Class RepositorySettingsBase

java.lang.Object
co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase
All Implemented Interfaces:
JsonpSerializable
Direct Known Subclasses:
AzureRepositorySettings, GcsRepositorySettings, ReadOnlyUrlRepositorySettings, S3RepositorySettings, SharedFileSystemRepositorySettings, SourceOnlyRepositorySettings
public abstract class RepositorySettingsBase extends Object implements JsonpSerializable
See Also:

  • Constructor Details

  • Method Details

    • chunkSize

      @Nullable public final String chunkSize()
      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

      @Nullable public final Boolean compress()
      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

      @Nullable public final String maxRestoreBytesPerSec()
      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

      @Nullable public final String maxSnapshotBytesPerSec()
      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

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupRepositorySettingsBaseDeserializer

      protected static <BuilderT extends RepositorySettingsBase.AbstractBuilder<BuilderT>> void setupRepositorySettingsBaseDeserializer(ObjectDeserializer<BuilderT> op)