Package org.opensearch.client.opensearch.cluster

Class GetClusterSettingsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.GetClusterSettingsRequest

All Implemented Interfaces:

ToCopyableBuilder<GetClusterSettingsRequest.Builder,GetClusterSettingsRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class GetClusterSettingsRequest
extends RequestBase
implements ToCopyableBuilder<GetClusterSettingsRequest.Builder,GetClusterSettingsRequest>

Returns cluster settings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetClusterSettingsRequest.Builder	Builder for GetClusterSettingsRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetClusterSettingsRequest,GetClusterSettingsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.get_settings".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static GetClusterSettingsRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time to wait for a response from the cluster manager node.
boolean	equals(Object o)
final Boolean	flatSettings()	Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings.
int	hashCode()
final Boolean	includeDefaults()	When true, returns default cluster settings from the local node.
final Time	masterTimeout()	Deprecated.
static GetClusterSettingsRequest	of(Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)
final Time	timeout()	A duration.
GetClusterSettingsRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<GetClusterSettingsRequest,GetClusterSettingsResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.get_settings".

Method Details

of

public static GetClusterSettingsRequest of(Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

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

@Nullable
public final Boolean flatSettings()

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

@Nullable
public final Boolean includeDefaults()

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

API name: include_defaults

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

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

@Nullable
public final Time timeout()

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

toBuilder

@Nonnull
public GetClusterSettingsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetClusterSettingsRequest.Builder,GetClusterSettingsRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetClusterSettingsRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object