Class GetClusterSettingsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cluster.GetClusterSettingsRequest
public class GetClusterSettingsRequest extends RequestBase
Returns cluster settings.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetClusterSettingsRequest.Builder
Builder forGetClusterSettingsRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<GetClusterSettingsRequest,GetClusterSettingsResponse,ErrorResponse>
_ENDPOINT
Endpoint "cluster.get_settings
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
flatSettings()
Return settings in flat format (default: false)java.lang.Boolean
includeDefaults()
Whether to return all default clusters setting.Time
masterTimeout()
Explicit operation timeout for connection to master nodestatic GetClusterSettingsRequest
of(java.util.function.Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)
Time
timeout()
Explicit operation timeoutMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
public static final Endpoint<GetClusterSettingsRequest,GetClusterSettingsResponse,ErrorResponse> _ENDPOINTEndpoint "cluster.get_settings
".
-
-
Method Details
-
of
public static GetClusterSettingsRequest of(java.util.function.Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn) -
flatSettings
@Nullable public final java.lang.Boolean flatSettings()Return settings in flat format (default: false)API name:
flat_settings
-
includeDefaults
@Nullable public final java.lang.Boolean includeDefaults()Whether to return all default clusters setting.API name:
include_defaults
-
masterTimeout
Explicit operation timeout for connection to master nodeAPI name:
master_timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-