Class GetClusterSettingsRequest.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<GetClusterSettingsRequest.Builder>
org.opensearch.client.opensearch.cluster.GetClusterSettingsRequest.Builder
- All Implemented Interfaces:
CopyableBuilder<GetClusterSettingsRequest.Builder,,GetClusterSettingsRequest> MutableBuilder<GetClusterSettingsRequest.Builder,,GetClusterSettingsRequest> ObjectBuilder<GetClusterSettingsRequest>
- Enclosing class:
GetClusterSettingsRequest
public static class GetClusterSettingsRequest.Builder
extends RequestBase.AbstractBuilder<GetClusterSettingsRequest.Builder>
implements CopyableBuilder<GetClusterSettingsRequest.Builder,GetClusterSettingsRequest>
Builder for
GetClusterSettingsRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aGetClusterSettingsRequest.The amount of time to wait for a response from the cluster manager node.clusterManagerTimeout(Time value) The amount of time to wait for a response from the cluster manager node.copy()Create a new builderCopyableBuilderthat is a copy of this one.flatSettings(Boolean value) Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings.includeDefaults(Boolean value) Whentrue, returns default cluster settings from the local node.Deprecated.masterTimeout(Time value) Deprecated.protected GetClusterSettingsRequest.Builderself()A duration.A duration.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder
errorTrace, humanMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<GetClusterSettingsRequest.Builder,GetClusterSettingsRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<GetClusterSettingsRequest.Builder>
-
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 -
clusterManagerTimeout
@Nonnull public final GetClusterSettingsRequest.Builder clusterManagerTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) 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
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
Whentrue, returns default cluster settings from the local node.API name:
include_defaults -
masterTimeout
@Deprecated @Nonnull public final GetClusterSettingsRequest.Builder masterTimeout(@Nullable Time value) Deprecated.A duration. Units can benanos,micros,ms(milliseconds),s(seconds),m(minutes),h(hours) andd(days). Also accepts0without a unit and-1to indicate an unspecified value.API name:
master_timeout -
masterTimeout
@Deprecated @Nonnull public final GetClusterSettingsRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Deprecated.A duration. Units can benanos,micros,ms(milliseconds),s(seconds),m(minutes),h(hours) andd(days). Also accepts0without a unit and-1to indicate an unspecified value.API name:
master_timeout -
timeout
A duration. Units can benanos,micros,ms(milliseconds),s(seconds),m(minutes),h(hours) andd(days). Also accepts0without a unit and-1to indicate an unspecified value.API name:
timeout -
timeout
@Nonnull public final GetClusterSettingsRequest.Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) A duration. Units can benanos,micros,ms(milliseconds),s(seconds),m(minutes),h(hours) andd(days). Also accepts0without a unit and-1to indicate an unspecified value.API name:
timeout -
build
Builds aGetClusterSettingsRequest.- Specified by:
buildin interfaceObjectBuilder<GetClusterSettingsRequest>- Throws:
NullPointerException- if some of the required fields are null.
-