Package org.opensearch.client.opensearch.cluster

Class GetClusterSettingsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<GetClusterSettingsRequest>

Enclosing class:

GetClusterSettingsRequest

public static class GetClusterSettingsRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<GetClusterSettingsRequest>

Builder for GetClusterSettingsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetClusterSettingsRequest	build()	Builds a GetClusterSettingsRequest.
GetClusterSettingsRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout for connection to cluster-manager node
GetClusterSettingsRequest.Builder	clusterManagerTimeout(Time value)	Explicit operation timeout for connection to cluster-manager node
GetClusterSettingsRequest.Builder	flatSettings(java.lang.Boolean value)	Return settings in flat format (default: false)
GetClusterSettingsRequest.Builder	includeDefaults(java.lang.Boolean value)	Whether to return all default clusters setting.
GetClusterSettingsRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
GetClusterSettingsRequest.Builder	masterTimeout(Time value)	Deprecated.
GetClusterSettingsRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
GetClusterSettingsRequest.Builder	timeout(Time value)	Explicit operation timeout

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

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

flatSettings

public final GetClusterSettingsRequest.Builder flatSettings(@Nullable
                                                            java.lang.Boolean value)

Return settings in flat format (default: false)

API name: flat_settings

includeDefaults

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

Whether to return all default clusters setting.

API name: include_defaults

masterTimeout

@Deprecated
public final GetClusterSettingsRequest.Builder masterTimeout(@Nullable
                                                             Time value)

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

masterTimeout

@Deprecated
public final GetClusterSettingsRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

clusterManagerTimeout

public final GetClusterSettingsRequest.Builder clusterManagerTimeout(@Nullable
                                                                     Time value)

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

clusterManagerTimeout

public final GetClusterSettingsRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

timeout

public final GetClusterSettingsRequest.Builder timeout(@Nullable
                                                       Time value)

Explicit operation timeout

API name: timeout

timeout

public final GetClusterSettingsRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

build

public GetClusterSettingsRequest build()

Builds a GetClusterSettingsRequest.

Specified by:

build in interface ObjectBuilder<GetClusterSettingsRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.