Package org.opensearch.client.opensearch.cluster

Class PutClusterSettingsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<PutClusterSettingsRequest.Builder>

org.opensearch.client.opensearch.cluster.PutClusterSettingsRequest.Builder

All Implemented Interfaces:

CopyableBuilder<PutClusterSettingsRequest.Builder,PutClusterSettingsRequest>, MutableBuilder<PutClusterSettingsRequest.Builder,PutClusterSettingsRequest>, ObjectBuilder<PutClusterSettingsRequest>

Enclosing class:

PutClusterSettingsRequest

public static class PutClusterSettingsRequest.Builder
extends RequestBase.AbstractBuilder<PutClusterSettingsRequest.Builder>
implements CopyableBuilder<PutClusterSettingsRequest.Builder,PutClusterSettingsRequest>

Builder for PutClusterSettingsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutClusterSettingsRequest	build()	Builds a PutClusterSettingsRequest.
final PutClusterSettingsRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final PutClusterSettingsRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
PutClusterSettingsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutClusterSettingsRequest.Builder	flatSettings(Boolean value)	Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings.
final PutClusterSettingsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final PutClusterSettingsRequest.Builder	masterTimeout(Time value)	Deprecated.
final PutClusterSettingsRequest.Builder	persistent(String key, JsonData value)	API name: persistent
final PutClusterSettingsRequest.Builder	persistent(Map<String,JsonData> map)	API name: persistent
protected PutClusterSettingsRequest.Builder	self()
final PutClusterSettingsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	A duration.
final PutClusterSettingsRequest.Builder	timeout(Time value)	A duration.
final PutClusterSettingsRequest.Builder	transient_(String key, JsonData value)	API name: transient
final PutClusterSettingsRequest.Builder	transient_(Map<String,JsonData> map)	API name: transient

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public PutClusterSettingsRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<PutClusterSettingsRequest.Builder,PutClusterSettingsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PutClusterSettingsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutClusterSettingsRequest.Builder>

clusterManagerTimeout

@Nonnull
public final PutClusterSettingsRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

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

clusterManagerTimeout

@Nonnull
public final PutClusterSettingsRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

@Nonnull
public final PutClusterSettingsRequest.Builder flatSettings(@Nullable
 Boolean value)

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
@Nonnull
public final PutClusterSettingsRequest.Builder masterTimeout(@Nullable
 Time value)

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

masterTimeout

@Deprecated
@Nonnull
public final PutClusterSettingsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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 PutClusterSettingsRequest.Builder persistent(Map<String,JsonData> map)

API name: persistent

Adds all elements of map to persistent.

persistent

@Nonnull
public final PutClusterSettingsRequest.Builder persistent(String key,
 JsonData value)

API name: persistent

Adds an entry to persistent.

timeout

@Nonnull
public final PutClusterSettingsRequest.Builder timeout(@Nullable
 Time value)

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

timeout

@Nonnull
public final PutClusterSettingsRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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 PutClusterSettingsRequest.Builder transient_(Map<String,JsonData> map)

API name: transient

Adds all elements of map to transient_.

transient_

@Nonnull
public final PutClusterSettingsRequest.Builder transient_(String key,
 JsonData value)

API name: transient

Adds an entry to transient_.

build

@Nonnull
public PutClusterSettingsRequest build()

Builds a PutClusterSettingsRequest.

Specified by:

build in interface ObjectBuilder<PutClusterSettingsRequest>

Throws:

NullPointerException - if some of the required fields are null.