Class PutIndicesSettingsRequest.Builder
- All Implemented Interfaces:
WithJson<PutIndicesSettingsRequest.Builder>
,ObjectBuilder<PutIndicesSettingsRequest>
- Enclosing class:
- PutIndicesSettingsRequest
PutIndicesSettingsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) Whether to ignore if a wildcard indices expression resolves into no concrete indices.build()
Builds aPutIndicesSettingsRequest
.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.flatSettings
(Boolean value) Return settings in flat format (default: false)ignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesA comma-separated list of index names; use_all
or empty string to perform the operation on all indicesmasterTimeout
(Time value) Specify timeout for connection to masterSpecify timeout for connection to masterpreserveExisting
(Boolean value) Whether to update existing settings.protected PutIndicesSettingsRequest.Builder
self()
settings
(IndexSettings value) Required - Request body.Required - Request body.Explicit operation timeoutExplicit operation timeoutwithJson
(jakarta.json.stream.JsonParser parser, JsonpMapper mapper) Sets additional properties values on this object by reading from a JSON input.Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoIndices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes_all
string or when no indices have been specified)API name:
allow_no_indices
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final PutIndicesSettingsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
flatSettings
Return settings in flat format (default: false)API name:
flat_settings
-
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds all elements of
list
toindex
. -
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds one or more values to
index
. -
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
masterTimeout
public final PutIndicesSettingsRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Specify timeout for connection to masterAPI name:
master_timeout
-
preserveExisting
Whether to update existing settings. If set totrue
existing settings on an index remain unchanged, the default isfalse
API name:
preserve_existing
-
timeout
Explicit operation timeoutAPI name:
timeout
-
timeout
public final PutIndicesSettingsRequest.Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Explicit operation timeoutAPI name:
timeout
-
settings
Required - Request body. -
settings
public final PutIndicesSettingsRequest.Builder settings(Function<IndexSettings.Builder, ObjectBuilder<IndexSettings>> fn) Required - Request body. -
withJson
public PutIndicesSettingsRequest.Builder withJson(jakarta.json.stream.JsonParser parser, JsonpMapper mapper) Description copied from interface:WithJson
Sets additional properties values on this object by reading from a JSON input.This is a "partial deserialization": properties that were already set keep their value if they're not present in the JSON input, and properties can also be set after having called this method, including overriding those read from the JSON input.
This low level variant of
withJson
gives full control on the json parser and object mapper. Most of the time usingWithJson.withJson(Reader)
andWithJson.withJson(InputStream)
will be more convenient.- Specified by:
withJson
in interfaceWithJson<PutIndicesSettingsRequest.Builder>
- Overrides:
withJson
in classWithJsonObjectBuilderBase<PutIndicesSettingsRequest.Builder>
- Parameters:
parser
- the JSONP parsermapper
- the JSONP mapper used to deserialize values and nested objects- Returns:
- this object
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<PutIndicesSettingsRequest.Builder>
-
build
Builds aPutIndicesSettingsRequest
.- Specified by:
build
in interfaceObjectBuilder<PutIndicesSettingsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-