Class GetClusterSettingsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cluster.GetClusterSettingsRequest
Returns cluster-wide settings. By default, it returns only settings that have
been explicitly defined.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionEndpoint "cluster.get_settings
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iftrue
, returns settings in flat format.final Boolean
Iftrue
, returns default cluster settings from the local node.final Time
Period to wait for a connection to the master node.static GetClusterSettingsRequest
final Time
timeout()
Period to wait for a response.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
public static final Endpoint<GetClusterSettingsRequest,GetClusterSettingsResponse, _ENDPOINTErrorResponse> Endpoint "cluster.get_settings
".
-
-
Method Details
-
of
public static GetClusterSettingsRequest of(Function<GetClusterSettingsRequest.Builder, ObjectBuilder<GetClusterSettingsRequest>> fn) -
flatSettings
Iftrue
, returns settings in flat format.API name:
flat_settings
-
includeDefaults
Iftrue
, returns default cluster settings from the local node.API name:
include_defaults
-
masterTimeout
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
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
-