Class CloseIndexResult.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.indices.close.CloseIndexResult.Builder
- All Implemented Interfaces:
CopyableBuilder<CloseIndexResult.Builder,,CloseIndexResult> MutableBuilder<CloseIndexResult.Builder,,CloseIndexResult> ObjectBuilder<CloseIndexResult>
- Enclosing class:
CloseIndexResult
public static class CloseIndexResult.Builder
extends ObjectBuilderBase
implements CopyableBuilder<CloseIndexResult.Builder,CloseIndexResult>
Builder for
CloseIndexResult.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aCloseIndexResult.final CloseIndexResult.Builderclosed(boolean value) Required - Whether the index was successfully closed.copy()Create a new builderCopyableBuilderthat is a copy of this one.final CloseIndexResult.BuilderThe status of individual shards during the close operation.final CloseIndexResult.Buildershards(String key, CloseShardResult value) The status of individual shards during the close operation.final CloseIndexResult.Buildershards(Map<String, CloseShardResult> map) The status of individual shards during the close operation.Methods 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<CloseIndexResult.Builder,CloseIndexResult> - Returns:
- a new builder instance.
-
closed
Required - Whether the index was successfully closed.API name:
closed -
shards
The status of individual shards during the close operation.API name:
shardsAdds all elements of
maptoshards. -
shards
The status of individual shards during the close operation.API name:
shardsAdds an entry to
shards. -
shards
@Nonnull public final CloseIndexResult.Builder shards(String key, Function<CloseShardResult.Builder, ObjectBuilder<CloseShardResult>> fn) The status of individual shards during the close operation.API name:
shardsAdds a value to
shardsusing a builder lambda. -
build
Builds aCloseIndexResult.- Specified by:
buildin interfaceObjectBuilder<CloseIndexResult>- Throws:
NullPointerException- if some of the required fields are null.
-