Package org.opensearch.client.opensearch.cluster

Class PutClusterSettingsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.PutClusterSettingsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutClusterSettingsRequest
extends RequestBase
implements JsonpSerializable

Updates the cluster settings.

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Explicit operation timeout for connection to cluster-manager node
java.lang.Boolean	flatSettings()	Return settings in flat format (default: false)
Time	masterTimeout()	Deprecated.
static PutClusterSettingsRequest	of(java.util.function.Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)
java.util.Map<java.lang.String,JsonData>	persistent()	API name: persistent
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)
Time	timeout()	Explicit operation timeout
java.util.Map<java.lang.String,JsonData>	transient_()	API name: transient

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<PutClusterSettingsRequest> _DESERIALIZER

Json deserializer for PutClusterSettingsRequest

_ENDPOINT

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

Endpoint "cluster.put_settings".

Method Detail

of

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

flatSettings

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

Return settings in flat format (default: false)

API name: flat_settings

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

persistent

public final java.util.Map<java.lang.String,JsonData> persistent()

API name: persistent

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

transient_

public final java.util.Map<java.lang.String,JsonData> transient_()

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)