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, PlainJsonSerializable, ToCopyableBuilder<PutClusterSettingsRequest.Builder,PutClusterSettingsRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class PutClusterSettingsRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<PutClusterSettingsRequest.Builder,PutClusterSettingsRequest>

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 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
protected void	applyQueryParameters(Map<String,String> params)
static PutClusterSettingsRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time to wait for a response from the cluster manager node.
boolean	equals(Object o)
final Boolean	flatSettings()	Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings.
int	hashCode()
final Time	masterTimeout()	Deprecated.
static PutClusterSettingsRequest	of(Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)
final Map<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)
final Time	timeout()	A duration.
PutClusterSettingsRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Map<String,JsonData>	transient_()	API name: transient

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

flatSettings

@Nullable
public final Boolean flatSettings()

Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "cluster": { "max_shards_per_node": 500 } is "cluster.max_shards_per_node": "500".

API name: flat_settings

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: master_timeout

persistent

@Nonnull
public final Map<String,JsonData> persistent()

API name: persistent

timeout

@Nullable
public final Time timeout()

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: timeout

transient_

@Nonnull
public final Map<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)

toBuilder

@Nonnull
public PutClusterSettingsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutClusterSettingsRequest.Builder,PutClusterSettingsRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static PutClusterSettingsRequest.Builder builder()

setupPutClusterSettingsRequestDeserializer

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

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object