Package org.opensearch.client.opensearch.cluster

Class GetClusterSettingsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.GetClusterSettingsRequest

public class GetClusterSettingsRequest
extends RequestBase

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 Endpoint<GetClusterSettingsRequest,GetClusterSettingsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.get_settings".

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

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

Endpoint "cluster.get_settings".

Method Detail

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

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout