Class Configuration
java.lang.Object
co.elastic.clients.elasticsearch.slm.Configuration
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public final class Configuration extends java.lang.Object implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Configuration.Builder
Builder forConfiguration
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<Configuration>
_DESERIALIZER
Json deserializer forConfiguration
-
Constructor Summary
Constructors Constructor Description Configuration(Configuration.Builder builder)
Configuration(java.util.function.Function<Configuration.Builder,Configuration.Builder> fn)
-
Method Summary
Modifier and Type Method Description java.util.List<java.lang.String>
featureStates()
A list of feature states to be included in this snapshot.java.lang.Boolean
ignoreUnavailable()
If false, the snapshot fails if any data stream or index in indices is missing or closed.java.lang.Boolean
includeGlobalState()
If true, the current global state is included in the snapshot.java.util.List<java.lang.String>
indices()
Required - A comma-separated list of data streams and indices to include in the snapshot.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.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.void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupConfigurationDeserializer(DelegatingDeserializer<Configuration.Builder> op)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forConfiguration
-
-
Constructor Details
-
Configuration
-
Configuration
-
-
Method Details
-
indices
public 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 java.lang.Boolean includeGlobalState()If true, the current global state is included in the snapshot.API name:
include_global_state
-
featureStates
@Nullable public 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
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 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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupConfigurationDeserializer
protected static void setupConfigurationDeserializer(DelegatingDeserializer<Configuration.Builder> op)