Package co.elastic.clients.elasticsearch.slm

Class Configuration.Builder

java.lang.Object
co.elastic.clients.elasticsearch.slm.Configuration.Builder
All Implemented Interfaces:
ObjectBuilder<Configuration>
Enclosing class:
Configuration
public static class Configuration.Builder
extends java.lang.Object
implements ObjectBuilder<Configuration>
Builder for Configuration.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • ignoreUnavailable

      public Configuration.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices.

      API name: ignore_unavailable

    • indices

      public Configuration.Builder indices​(java.util.List<java.lang.String> value)
      Required - A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported. By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters.

      API name: indices

    • indices

      public Configuration.Builder indices​(java.lang.String... value)
      Required - A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported. By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters.

      API name: indices

    • addIndices

      public Configuration.Builder addIndices​(java.lang.String value)
      Add a value to indices(List), creating the list if needed.

    • includeGlobalState

      public Configuration.Builder includeGlobalState​(@Nullable java.lang.Boolean value)
      If true, the current global state is included in the snapshot.

      API name: include_global_state

    • featureStates

      public Configuration.Builder featureStates​(@Nullable java.util.List<java.lang.String> value)
      A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API. Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false.

      API name: feature_states

    • featureStates

      public Configuration.Builder featureStates​(java.lang.String... value)
      A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API. Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false.

      API name: feature_states

    • addFeatureStates

      public Configuration.Builder addFeatureStates​(java.lang.String value)
      Add a value to featureStates(List), creating the list if needed.

    • metadata

      public Configuration.Builder metadata​(@Nullable java.util.Map<java.lang.String,​JsonData> value)
      Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes.

      API name: metadata

    • putMetadata

      public Configuration.Builder putMetadata​(java.lang.String key, JsonData value)
      Add a key/value to metadata(Map), creating the map if needed.

    • partial

      public Configuration.Builder partial​(@Nullable java.lang.Boolean value)
      If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available.

      API name: partial

    • build

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