Class PutIndicesSettingsRequest.Builder
- All Implemented Interfaces:
WithJson<PutIndicesSettingsRequest.Builder>
,ObjectBuilder<PutIndicesSettingsRequest>
- Enclosing class:
- PutIndicesSettingsRequest
PutIndicesSettingsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.build()
Builds aPutIndicesSettingsRequest
.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.flatSettings
(Boolean value) Iftrue
, returns settings in flat format.ignoreUnavailable
(Boolean value) Iftrue
, returns settings in flat format.Comma-separated list of data streams, indices, and aliases used to limit the request.Comma-separated list of data streams, indices, and aliases used to limit the request.masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.preserveExisting
(Boolean value) Iftrue
, existing index settings remain unchanged.protected PutIndicesSettingsRequest.Builder
self()
settings
(IndexSettings value) Required - Request body.Required - Request body.Period to wait for a response.Period to wait for a response.withJson
(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
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.API name:
allow_no_indices
-
expandWildcards
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such asopen,hidden
.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final PutIndicesSettingsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such asopen,hidden
.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
flatSettings
Iftrue
, returns settings in flat format.API name:
flat_settings
-
index
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*
). To target all data streams and indices, omit this parameter or use*
or_all
.API name:
index
Adds all elements of
list
toindex
. -
index
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*
). To target all data streams and indices, omit this parameter or use*
or_all
.API name:
index
Adds one or more values to
index
. -
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
masterTimeout
public final PutIndicesSettingsRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
preserveExisting
Iftrue
, existing index settings remain unchanged.API name:
preserve_existing
-
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-
timeout
public final PutIndicesSettingsRequest.Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API 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.
-