Package org.opensearch.client.opensearch.indices

Class PutIndicesSettingsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.PutIndicesSettingsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutIndicesSettingsRequest
extends RequestBase
implements JsonpSerializable

Updates the index settings.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PutIndicesSettingsRequest>	_DESERIALIZER
static Endpoint<PutIndicesSettingsRequest,PutIndicesSettingsResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.put_settings".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
Time	clusterManagerTimeout()	Specify timeout for connection to cluster-manager
protected static JsonpDeserializer<PutIndicesSettingsRequest>	createPutIndicesSettingsRequestDeserializer()
java.util.List<ExpandWildcard>	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
Time	masterTimeout()	Deprecated.
static PutIndicesSettingsRequest	of(java.util.function.Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)
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.
Time	timeout()	Explicit operation timeout

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<PutIndicesSettingsRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<PutIndicesSettingsRequest,PutIndicesSettingsResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.put_settings".

Method Detail

of

public static PutIndicesSettingsRequest of(java.util.function.Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)

allowNoIndices

@Nullable
public final 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

public final java.util.List<ExpandWildcard> expandWildcards()

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

API name: expand_wildcards

flatSettings

@Nullable
public final java.lang.Boolean flatSettings()

Return settings in flat format (default: false)

API name: flat_settings

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

index

public final 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

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

preserveExisting

@Nullable
public final 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 final Time timeout()

Explicit operation timeout

API name: timeout

settings

public final 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

createPutIndicesSettingsRequestDeserializer

protected static JsonpDeserializer<PutIndicesSettingsRequest> createPutIndicesSettingsRequestDeserializer()