Class SlmConfiguration.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<SlmConfiguration.Builder>
co.elastic.clients.elasticsearch.slm.SlmConfiguration.Builder
- All Implemented Interfaces:
WithJson<SlmConfiguration.Builder>
,ObjectBuilder<SlmConfiguration>
- Enclosing class:
- SlmConfiguration
public static class SlmConfiguration.Builder
extends WithJsonObjectBuilderBase<SlmConfiguration.Builder>
implements ObjectBuilder<SlmConfiguration>
Builder for
SlmConfiguration
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aSlmConfiguration
.final SlmConfiguration.Builder
featureStates
(String value, String... values) A list of feature states to be included in this snapshot.final SlmConfiguration.Builder
featureStates
(List<String> list) A list of feature states to be included in this snapshot.final SlmConfiguration.Builder
ignoreUnavailable
(Boolean value) If false, the snapshot fails if any data stream or index in indices is missing or closed.final SlmConfiguration.Builder
includeGlobalState
(Boolean value) If true, the current global state is included in the snapshot.final SlmConfiguration.Builder
A comma-separated list of data streams and indices to include in the snapshot.final SlmConfiguration.Builder
A comma-separated list of data streams and indices to include in the snapshot.final SlmConfiguration.Builder
Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data.final SlmConfiguration.Builder
Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data.final SlmConfiguration.Builder
If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available.protected SlmConfiguration.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
indices
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
Adds all elements of
list
toindices
. -
indices
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
Adds one or more values to
indices
. -
includeGlobalState
If true, the current global state is included in the snapshot.API name:
include_global_state
-
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
Adds all elements of
list
tofeatureStates
. -
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
Adds one or more values to
featureStates
. -
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
Adds all entries of
map
tometadata
. -
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
Adds an entry to
metadata
. -
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
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<SlmConfiguration.Builder>
-
build
Builds aSlmConfiguration
.- Specified by:
build
in interfaceObjectBuilder<SlmConfiguration>
- Throws:
NullPointerException
- if some of the required fields are null.