Package co.elastic.clients.elasticsearch.cluster

Class PutClusterSettingsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cluster.PutClusterSettingsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutClusterSettingsRequest
extends RequestBase
implements JsonpSerializable

Update the cluster settings.

Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in elasticsearch.yml.

Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value.

If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) elasticsearch.yml setting; 4) Default setting value. For example, you can apply a transient setting to override a persistent setting or elasticsearch.yml setting. However, a change to an elasticsearch.yml setting will not override a defined transient or persistent setting.

TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. Only use elasticsearch.yml for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes.

WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<PutClusterSettingsRequest>	_DESERIALIZER	Json deserializer for PutClusterSettingsRequest
static final Endpoint<PutClusterSettingsRequest,PutClusterSettingsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.put_settings".

Method Summary

Modifier and Type	Method	Description
final Boolean	flatSettings()	Return settings in flat format (default: false)
final Time	masterTimeout()	Explicit operation timeout for connection to master node
static PutClusterSettingsRequest	of(Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)
final Map<String,JsonData>	persistent()	The settings that persist after the cluster restarts.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPutClusterSettingsRequestDeserializer(ObjectDeserializer<PutClusterSettingsRequest.Builder> op)
final Time	timeout()	Explicit operation timeout
final Map<String,JsonData>	transient_()	The settings that do not persist after the cluster restarts.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutClusterSettingsRequest> _DESERIALIZER

Json deserializer for PutClusterSettingsRequest

_ENDPOINT

public static final Endpoint<PutClusterSettingsRequest,PutClusterSettingsResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.put_settings".

Method Details

of

public static PutClusterSettingsRequest of(Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)

flatSettings

@Nullable
public final Boolean flatSettings()

Return settings in flat format (default: false)

API name: flat_settings

masterTimeout

@Nullable
public final Time masterTimeout()

Explicit operation timeout for connection to master node

API name: master_timeout

persistent

public final Map<String,JsonData> persistent()

The settings that persist after the cluster restarts.

API name: persistent

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

transient_

public final Map<String,JsonData> transient_()

The settings that do not persist after the cluster restarts.

API name: transient

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupPutClusterSettingsRequestDeserializer

protected static void setupPutClusterSettingsRequestDeserializer(ObjectDeserializer<PutClusterSettingsRequest.Builder> op)