Package co.elastic.clients.elasticsearch.cluster

Class GetClusterSettingsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetClusterSettingsRequest.Builder>

co.elastic.clients.elasticsearch.cluster.GetClusterSettingsRequest.Builder

All Implemented Interfaces:

WithJson<GetClusterSettingsRequest.Builder>, ObjectBuilder<GetClusterSettingsRequest>

Enclosing class:

GetClusterSettingsRequest

public static class GetClusterSettingsRequest.Builder
extends RequestBase.AbstractBuilder<GetClusterSettingsRequest.Builder>
implements ObjectBuilder<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	flatSettings(Boolean value)	If true, returns settings in flat format.
final GetClusterSettingsRequest.Builder	includeDefaults(Boolean value)	If true, also returns default values for all other cluster settings, reflecting the values in the elasticsearch.yml file of one of the nodes in the cluster.
final GetClusterSettingsRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final GetClusterSettingsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
protected GetClusterSettingsRequest.Builder	self()
final GetClusterSettingsRequest.Builder	timeout(Time value)	Period to wait for a response.
final GetClusterSettingsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

flatSettings

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

If true, returns settings in flat format.

API name: flat_settings

includeDefaults

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

If true, also returns default values for all other cluster settings, reflecting the values in the elasticsearch.yml file of one of the nodes in the cluster. If the nodes in your cluster do not all have the same values in their elasticsearch.yml config files then the values returned by this API may vary from invocation to invocation and may not reflect the values that Elasticsearch uses in all situations. Use the GET _nodes/settings API to fetch the settings for each individual node in your cluster.

API name: include_defaults

masterTimeout

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

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

public final GetClusterSettingsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

timeout

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

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

timeout

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

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

self

protected GetClusterSettingsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetClusterSettingsRequest.Builder>

build

public GetClusterSettingsRequest build()

Builds a GetClusterSettingsRequest.

Specified by:

build in interface ObjectBuilder<GetClusterSettingsRequest>

Throws:

NullPointerException - if some of the required fields are null.