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
Updates the index settings.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutIndicesSettingsRequest>
Endpoint "indices.put_settings
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Whether to ignore if a wildcard indices expression resolves into no concrete indices.protected static JsonpDeserializer<PutIndicesSettingsRequest>
final List<ExpandWildcard>
Whether to expand wildcard expression to concrete indices that are open, closed or both.final Boolean
Return settings in flat format (default: false)final Boolean
Whether specified concrete indices should be ignored when unavailable (missing or closed)index()
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesfinal Time
Specify timeout for connection to masterstatic PutIndicesSettingsRequest
final Boolean
Whether to update existing settings.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this value to JSON.final IndexSettings
settings()
Required - Request body.final Time
timeout()
Explicit operation timeoutMethods 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
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
-
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
-
masterTimeout
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
-
settings
Required - Request body. -
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createPutIndicesSettingsRequestDeserializer
protected static JsonpDeserializer<PutIndicesSettingsRequest> createPutIndicesSettingsRequestDeserializer()
-