Package co.elastic.clients.elasticsearch.indices

Class PutSettingsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.PutSettingsRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class PutSettingsRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PutSettingsRequest.Builder	Builder for PutSettingsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PutSettingsRequest>	_DESERIALIZER
static Endpoint<PutSettingsRequest,PutSettingsResponse,ElasticsearchError>	ENDPOINT	Endpoint "indices.put_settings".

Constructor Summary

Constructors

Constructor	Description
PutSettingsRequest(PutSettingsRequest.Builder builder)
PutSettingsRequest(java.util.function.Function<PutSettingsRequest.Builder,PutSettingsRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
protected static JsonpDeserializer<PutSettingsRequest>	createPutSettingsRequestDeserializer()
java.util.List<ExpandWildcardOptions>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
java.lang.Boolean	flatSettings()	Return settings in flat format (default: false)
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.util.List<java.lang.String>	index()	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
java.lang.String	masterTimeout()	Specify timeout for connection to master
java.lang.Boolean	preserveExisting()	Whether to update existing settings.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
IndexSettings	settings()	Required - Request body.
java.lang.String	timeout()	Explicit operation timeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutSettingsRequest> _DESERIALIZER

ENDPOINT

public static final Endpoint<PutSettingsRequest,PutSettingsResponse,ElasticsearchError> ENDPOINT

Endpoint "indices.put_settings".

Constructor Details

PutSettingsRequest

public PutSettingsRequest(PutSettingsRequest.Builder builder)

PutSettingsRequest

public PutSettingsRequest(java.util.function.Function<PutSettingsRequest.Builder,PutSettingsRequest.Builder> fn)

Method Details

index

@Nullable
public java.util.List<java.lang.String> index()

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

allowNoIndices

@Nullable
public java.lang.Boolean 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

@Nullable
public java.util.List<ExpandWildcardOptions> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

flatSettings

@Nullable
public java.lang.Boolean flatSettings()

Return settings in flat format (default: false)

API name: flat_settings

ignoreUnavailable

@Nullable
public java.lang.Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

masterTimeout

@Nullable
public java.lang.String masterTimeout()

Specify timeout for connection to master

API name: master_timeout

preserveExisting

@Nullable
public java.lang.Boolean preserveExisting()

Whether to update existing settings. If set to true existing settings on an index remain unchanged, the default is false

API name: preserve_existing

timeout

@Nullable
public java.lang.String timeout()

Explicit operation timeout

API name: timeout

settings

public IndexSettings settings()

Required - Request body.

API name: _value_body

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

createPutSettingsRequestDeserializer

protected static JsonpDeserializer<PutSettingsRequest> createPutSettingsRequestDeserializer()