Package co.elastic.clients.elasticsearch.indices

Class AliasDefinition.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<AliasDefinition.Builder>

co.elastic.clients.elasticsearch.indices.AliasDefinition.Builder

All Implemented Interfaces:

WithJson<AliasDefinition.Builder>, ObjectBuilder<AliasDefinition>

Enclosing class:

AliasDefinition

public static class AliasDefinition.Builder
extends WithJsonObjectBuilderBase<AliasDefinition.Builder>
implements ObjectBuilder<AliasDefinition>

Builder for AliasDefinition.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AliasDefinition	build()	Builds a AliasDefinition.
final AliasDefinition.Builder	filter(Query value)	Query used to limit documents the alias can access.
final AliasDefinition.Builder	filter(QueryVariant value)	Query used to limit documents the alias can access.
final AliasDefinition.Builder	filter(Function<Query.Builder,ObjectBuilder<Query>> fn)	Query used to limit documents the alias can access.
final AliasDefinition.Builder	indexRouting(String value)	Value used to route indexing operations to a specific shard.
final AliasDefinition.Builder	isHidden(Boolean value)	If true, the alias is hidden.
final AliasDefinition.Builder	isWriteIndex(Boolean value)	If true, the index is the write index for the alias.
final AliasDefinition.Builder	routing(String value)	Value used to route indexing and search operations to a specific shard.
final AliasDefinition.Builder	searchRouting(String value)	Value used to route search operations to a specific shard.
protected AliasDefinition.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

filter

public final AliasDefinition.Builder filter(@Nullable
 Query value)

Query used to limit documents the alias can access.

API name: filter

filter

public final AliasDefinition.Builder filter(Function<Query.Builder,ObjectBuilder<Query>> fn)

Query used to limit documents the alias can access.

API name: filter

filter

public final AliasDefinition.Builder filter(QueryVariant value)

Query used to limit documents the alias can access.

API name: filter

indexRouting

public final AliasDefinition.Builder indexRouting(@Nullable
 String value)

Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.

API name: index_routing

isWriteIndex

public final AliasDefinition.Builder isWriteIndex(@Nullable
 Boolean value)

If true, the index is the write index for the alias.

API name: is_write_index

routing

public final AliasDefinition.Builder routing(@Nullable
 String value)

Value used to route indexing and search operations to a specific shard.

API name: routing

searchRouting

public final AliasDefinition.Builder searchRouting(@Nullable
 String value)

Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.

API name: search_routing

isHidden

public final AliasDefinition.Builder isHidden(@Nullable
 Boolean value)

If true, the alias is hidden. All indices for the alias must have the same is_hidden value.

API name: is_hidden

self

protected AliasDefinition.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<AliasDefinition.Builder>

build

public AliasDefinition build()

Builds a AliasDefinition.

Specified by:

build in interface ObjectBuilder<AliasDefinition>

Throws:

NullPointerException - if some of the required fields are null.