Package co.elastic.clients.elasticsearch.snapshot

Class AzureRepositorySettings

java.lang.Object
co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase
co.elastic.clients.elasticsearch.snapshot.AzureRepositorySettings
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class AzureRepositorySettings extends RepositorySettingsBase
See Also:

  • Field Details

  • Method Details

    • of

      public static AzureRepositorySettings of(Function<AzureRepositorySettings.Builder,ObjectBuilder<AzureRepositorySettings>> fn)

    • basePath

      @Nullable public final String basePath()
      The path to the repository data within the container. It defaults to the root directory.

      NOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise. Elastic Cloud Enterprise automatically generates the base_path for each deployment so that multiple deployments can share the same bucket.

      API name: base_path

    • client

      @Nullable public final String client()
      The name of the Azure repository client to use.

      API name: client

    • container

      @Nullable public final String container()
      The Azure container.

      API name: container

    • deleteObjectsMaxSize

      @Nullable public final Integer deleteObjectsMaxSize()
      The maxmimum batch size, between 1 and 256, used for BlobBatch requests. Defaults to 256 which is the maximum number supported by the Azure blob batch API.

      API name: delete_objects_max_size

    • locationMode

      @Nullable public final String locationMode()
      Either primary_only or secondary_only. Note that if you set it to secondary_only, it will force readonly to true.

      API name: location_mode

    • maxConcurrentBatchDeletes

      @Nullable public final Integer maxConcurrentBatchDeletes()
      The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with BlobBatch. Note that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits. Defaults to 10, minimum is 1, maximum is 100.

      API name: max_concurrent_batch_deletes

    • readonly

      @Nullable public final Boolean readonly()
      If true, the repository is read-only. The cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.

      Only a cluster with write access can create snapshots in the repository. All other clusters connected to the repository should have the readonly parameter set to true. If false, the cluster can write to the repository and create snapshots in it.

      IMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository. Having multiple clusters write to the repository at the same time risks corrupting the contents of the repository.

      API name: readonly

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class RepositorySettingsBase

    • setupAzureRepositorySettingsDeserializer

      protected static void setupAzureRepositorySettingsDeserializer(ObjectDeserializer<AzureRepositorySettings.Builder> op)