Package co.elastic.clients.elasticsearch.indices

Class Alias

java.lang.Object

co.elastic.clients.elasticsearch.indices.Alias

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class Alias
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Alias.Builder	Builder for Alias.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Alias>	_DESERIALIZER	Json deserializer for Alias

Method Summary

Modifier and Type	Method	Description
final Query	filter()	Query used to limit documents the alias can access.
final String	indexRouting()	Value used to route indexing operations to a specific shard.
final Boolean	isHidden()	If true, the alias is hidden.
final Boolean	isWriteIndex()	If true, the index is the write index for the alias.
static Alias	of(Function<Alias.Builder,ObjectBuilder<Alias>> fn)
final String	routing()	Value used to route indexing and search operations to a specific shard.
final String	searchRouting()	Value used to route search operations to a specific shard.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupAliasDeserializer(ObjectDeserializer<Alias.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Alias> _DESERIALIZER

Json deserializer for Alias

Method Details

of

public static Alias of(Function<Alias.Builder,ObjectBuilder<Alias>> fn)

filter

@Nullable
public final Query filter()

Query used to limit documents the alias can access.

API name: filter

indexRouting

@Nullable
public final String indexRouting()

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

API name: index_routing

isHidden

@Nullable
public final Boolean isHidden()

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

API name: is_hidden

isWriteIndex

@Nullable
public final Boolean isWriteIndex()

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

API name: is_write_index

routing

@Nullable
public final String routing()

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

API name: routing

searchRouting

@Nullable
public final String searchRouting()

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

API name: search_routing

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupAliasDeserializer

protected static void setupAliasDeserializer(ObjectDeserializer<Alias.Builder> op)