Class AliasDefinition.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.indices.AliasDefinition.Builder
- All Implemented Interfaces:
CopyableBuilder<AliasDefinition.Builder,,AliasDefinition> MutableBuilder<AliasDefinition.Builder,,AliasDefinition> ObjectBuilder<AliasDefinition>
- Enclosing class:
AliasDefinition
public static class AliasDefinition.Builder
extends ObjectBuilderBase
implements CopyableBuilder<AliasDefinition.Builder,AliasDefinition>
Builder for
AliasDefinition.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aAliasDefinition.copy()Create a new builderCopyableBuilderthat is a copy of this one.final AliasDefinition.BuilderAPI name:filterfinal AliasDefinition.BuilderAPI name:filterfinal AliasDefinition.BuilderindexRouting(String value) The value used to route indexing operations to a specific shard.final AliasDefinition.BuilderWhentrue, the alias is hidden.final AliasDefinition.BuilderisWriteIndex(Boolean value) Whentrue, the index is the write index for the alias.final AliasDefinition.BuilderThe value used to route indexing and search operations to a specific shard.final AliasDefinition.BuildersearchRouting(String value) The value used to route search operations to a specific shard.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<AliasDefinition.Builder,AliasDefinition> - Returns:
- a new builder instance.
-
filter
API name:filter -
filter
@Nonnull public final AliasDefinition.Builder filter(Function<Query.Builder, ObjectBuilder<Query>> fn) API name:filter -
indexRouting
The value used to route indexing operations to a specific shard. When specified, this overwrites theroutingvalue for indexing operations.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
The value used to route indexing and search operations to a specific shard.API name:
routing -
searchRouting
The value used to route search operations to a specific shard. When specified, this overwrites theroutingvalue for search operations.API name:
search_routing -
build
Builds aAliasDefinition.- Specified by:
buildin interfaceObjectBuilder<AliasDefinition>- Throws:
NullPointerException- if some of the required fields are null.
-