Class Alias.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.indices.Alias.Builder
- All Implemented Interfaces:
CopyableBuilder<Alias.Builder,,Alias> MutableBuilder<Alias.Builder,,Alias> ObjectBuilder<Alias>
- Enclosing class:
Alias
public static class Alias.Builder
extends ObjectBuilderBase
implements CopyableBuilder<Alias.Builder,Alias>
Builder for
Alias.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aAlias.copy()Create a new builderCopyableBuilderthat is a copy of this one.final Alias.BuilderAPI name:filterfinal Alias.BuilderAPI name:filterfinal Alias.BuilderindexRouting(String value) API name:index_routingfinal Alias.BuilderWhentrue, the alias is hidden.final Alias.BuilderisWriteIndex(Boolean value) Whentrue, the index is the write index for the alias.final Alias.BuilderAPI name:routingfinal Alias.BuildersearchRouting(String value) API name:search_routingMethods 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<Alias.Builder,Alias> - Returns:
- a new builder instance.
-
filter
API name:filter -
filter
API name:filter -
indexRouting
API name:index_routing -
isHidden
Whentrue, the alias is hidden. All indexes for the alias must have the sameis_hiddenvalue.API name:
is_hidden -
isWriteIndex
Whentrue, the index is the write index for the alias.API name:
is_write_index -
routing
API name:routing -
searchRouting
API name:search_routing -
build
Builds aAlias.- Specified by:
buildin interfaceObjectBuilder<Alias>- Throws:
NullPointerException- if some of the required fields are null.
-