Class PutIndicesSettingsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.PutIndicesSettingsRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutIndicesSettingsRequest
extends RequestBase
implements JsonpSerializable
Changes a dynamic index setting in real time. For data streams, index setting
changes are applied to all backing indices by default.
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutIndicesSettingsRequest>
Endpoint "indices.put_settings
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.protected static JsonpDeserializer<PutIndicesSettingsRequest>
final List<ExpandWildcard>
Type of index that wildcard patterns can match.final Boolean
Iftrue
, returns settings in flat format.final Boolean
Iftrue
, returns settings in flat format.index()
Comma-separated list of data streams, indices, and aliases used to limit the request.final Time
Period to wait for a connection to the master node.static PutIndicesSettingsRequest
final Boolean
Iftrue
, existing index settings remain unchanged.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this value to JSON.final IndexSettings
settings()
Required - Request body.final Time
timeout()
Period to wait for a response.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
-
_ENDPOINT
public static final Endpoint<PutIndicesSettingsRequest,PutIndicesSettingsResponse, _ENDPOINTErrorResponse> Endpoint "indices.put_settings
".
-
-
Method Details
-
of
public static PutIndicesSettingsRequest of(Function<PutIndicesSettingsRequest.Builder, ObjectBuilder<PutIndicesSettingsRequest>> fn) -
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
-
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
-
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
-
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
-
settings
Required - Request body. -
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createPutIndicesSettingsRequestDeserializer
protected static JsonpDeserializer<PutIndicesSettingsRequest> createPutIndicesSettingsRequestDeserializer()
-