Package co.elastic.clients.elasticsearch.snapshot

Class GcsRepositorySettings

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

  • Field Details

  • Method Details

    • of

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

    • bucket

      public final String bucket()
      Required - The name of the bucket to be used for snapshots.

      API name: bucket

    • applicationName

      @Deprecated @Nullable public final String applicationName()
      Deprecated.
      6.3.0
      The name used by the client when it uses the Google Cloud Storage service.

      API name: application_name

    • basePath

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

      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 client to use to connect to Google Cloud Storage.

      API name: client

    • 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

    • setupGcsRepositorySettingsDeserializer

      protected static void setupGcsRepositorySettingsDeserializer(ObjectDeserializer<GcsRepositorySettings.Builder> op)