Class ShardsRequest.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ShardsRequest.Builder>
org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<ShardsRequest.Builder>
org.opensearch.client.opensearch.cat.ShardsRequest.Builder
- All Implemented Interfaces:
CopyableBuilder<ShardsRequest.Builder,,ShardsRequest> MutableBuilder<ShardsRequest.Builder,,ShardsRequest> ObjectBuilder<ShardsRequest>
- Enclosing class:
ShardsRequest
public static class ShardsRequest.Builder
extends CatRequestBase.AbstractBuilder<ShardsRequest.Builder>
implements CopyableBuilder<ShardsRequest.Builder,ShardsRequest>
Builder for
ShardsRequest.-
Field Summary
Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder
headers, sort -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aShardsRequest.final ShardsRequest.BuilderThe units used to display byte values.final ShardsRequest.BuilderThe amount of time allowed to establish a connection to the cluster manager node.final ShardsRequest.BuilderclusterManagerTimeout(Time value) The amount of time allowed to establish a connection to the cluster manager node.copy()Create a new builderCopyableBuilderthat is a copy of this one.final ShardsRequest.BuilderA comma-separated list of data streams, indexes, and aliases used to limit the request.final ShardsRequest.BuilderA comma-separated list of data streams, indexes, and aliases used to limit the request.final ShardsRequest.BuilderDeprecated.final ShardsRequest.BuildermasterTimeout(Time value) Deprecated.protected ShardsRequest.Builderself()final ShardsRequest.BuilderSpecifies the time units, for example,5dor7h.Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder
headers, headers, sort, sortMethods 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<ShardsRequest.Builder,ShardsRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<ShardsRequest.Builder>
-
bytes
The units used to display byte values.API name:
bytes -
clusterManagerTimeout
The amount of time allowed to establish a connection to the cluster manager node.API name:
cluster_manager_timeout -
clusterManagerTimeout
@Nonnull public final ShardsRequest.Builder clusterManagerTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) The amount of time allowed to establish a connection to the cluster manager node.API name:
cluster_manager_timeout -
index
A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use*or_all.API name:
indexAdds all elements of
listtoindex. -
index
A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use*or_all.API name:
indexAdds one or more values to
index. -
masterTimeout
Deprecated.The amount of time allowed to establish a connection to the cluster manager node.API name:
master_timeout -
masterTimeout
@Deprecated @Nonnull public final ShardsRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Deprecated.The amount of time allowed to establish a connection to the cluster manager node.API name:
master_timeout -
time
Specifies the time units, for example,5dor7h. For more information, see Supported units.API name:
time -
build
Builds aShardsRequest.- Specified by:
buildin interfaceObjectBuilder<ShardsRequest>- Throws:
NullPointerException- if some of the required fields are null.
-