Package co.elastic.clients.elasticsearch.slm

Class SlmConfiguration

java.lang.Object
co.elastic.clients.elasticsearch.slm.SlmConfiguration
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class SlmConfiguration
extends java.lang.Object
implements JsonpSerializable
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static SlmConfiguration of​(java.util.function.Function<SlmConfiguration.Builder,​ObjectBuilder<SlmConfiguration>> fn)

    • ignoreUnavailable

      @Nullable public final java.lang.Boolean ignoreUnavailable()
      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 final java.util.List<java.lang.String> indices()
      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

    • includeGlobalState

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

      API name: include_global_state

    • featureStates

      public final java.util.List<java.lang.String> featureStates()
      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

    • metadata

      public final java.util.Map<java.lang.String,​JsonData> metadata()
      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

    • partial

      @Nullable public final java.lang.Boolean partial()
      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

    • 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)

    • setupSlmConfigurationDeserializer

      protected static void setupSlmConfigurationDeserializer​(ObjectDeserializer<SlmConfiguration.Builder> op)