Package org.opensearch.client.opensearch.cluster

Class GetClusterSettingsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cluster.GetClusterSettingsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetClusterSettingsRequest

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

Builder for GetClusterSettingsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetClusterSettingsRequest	build()	Builds a GetClusterSettingsRequest.
final GetClusterSettingsRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final GetClusterSettingsRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
GetClusterSettingsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetClusterSettingsRequest.Builder	flatSettings(Boolean value)	Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings.
final GetClusterSettingsRequest.Builder	includeDefaults(Boolean value)	When true, returns default cluster settings from the local node.
final GetClusterSettingsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final GetClusterSettingsRequest.Builder	masterTimeout(Time value)	Deprecated.
protected GetClusterSettingsRequest.Builder	self()
final GetClusterSettingsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	A duration.
final GetClusterSettingsRequest.Builder	timeout(Time value)	A duration.

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 GetClusterSettingsRequest.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<GetClusterSettingsRequest.Builder,GetClusterSettingsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetClusterSettingsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetClusterSettingsRequest.Builder>

clusterManagerTimeout

@Nonnull
public final GetClusterSettingsRequest.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 GetClusterSettingsRequest.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 GetClusterSettingsRequest.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

includeDefaults

@Nonnull
public final GetClusterSettingsRequest.Builder includeDefaults(@Nullable
 Boolean value)

When true, returns default cluster settings from the local node.

API name: include_defaults

masterTimeout

@Deprecated
@Nonnull
public final GetClusterSettingsRequest.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 GetClusterSettingsRequest.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

timeout

@Nonnull
public final GetClusterSettingsRequest.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 GetClusterSettingsRequest.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

build

@Nonnull
public GetClusterSettingsRequest build()

Builds a GetClusterSettingsRequest.

Specified by:

build in interface ObjectBuilder<GetClusterSettingsRequest>

Throws:

NullPointerException - if some of the required fields are null.