Package co.elastic.clients.elasticsearch.snapshot

Class GcsRepositorySettings.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase.AbstractBuilder<GcsRepositorySettings.Builder>
co.elastic.clients.elasticsearch.snapshot.GcsRepositorySettings.Builder
All Implemented Interfaces:
WithJson<GcsRepositorySettings.Builder>, ObjectBuilder<GcsRepositorySettings>
Enclosing class:
GcsRepositorySettings
public static class GcsRepositorySettings.Builder extends RepositorySettingsBase.AbstractBuilder<GcsRepositorySettings.Builder> implements ObjectBuilder<GcsRepositorySettings>
Builder for GcsRepositorySettings.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bucket

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

      API name: bucket

    • applicationName

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

      API name: application_name

    • basePath

      public final GcsRepositorySettings.Builder basePath(@Nullable String value)
      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

      public final GcsRepositorySettings.Builder client(@Nullable String value)
      The name of the client to use to connect to Google Cloud Storage.

      API name: client

    • readonly

      public final GcsRepositorySettings.Builder readonly(@Nullable Boolean value)
      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

    • self

      protected GcsRepositorySettings.Builder self()
      Specified by:
      self in class RepositorySettingsBase.AbstractBuilder<GcsRepositorySettings.Builder>

    • build

      public GcsRepositorySettings build()
      Builds a GcsRepositorySettings.
      Specified by:
      build in interface ObjectBuilder<GcsRepositorySettings>
      Throws:
      NullPointerException - if some of the required fields are null.