Package org.opensearch.client.opensearch.indices

Class AliasDefinition

java.lang.Object

org.opensearch.client.opensearch.indices.AliasDefinition

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<AliasDefinition.Builder,AliasDefinition>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class AliasDefinition
extends java.lang.Object
implements PlainJsonSerializable, ToCopyableBuilder<AliasDefinition.Builder,AliasDefinition>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static AliasDefinition.Builder	builder()
boolean	equals(java.lang.Object o)
Query	filter()	API name: filter
int	hashCode()
java.lang.String	indexRouting()	Value used to route indexing operations to a specific shard.
java.lang.Boolean	isHidden()	If true, the alias is hidden.
java.lang.Boolean	isWriteIndex()	If true, the index is the write index for the alias.
static AliasDefinition	of(java.util.function.Function<AliasDefinition.Builder,ObjectBuilder<AliasDefinition>> fn)
java.lang.String	routing()	Value used to route indexing and search operations to a specific shard.
java.lang.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	setupAliasDefinitionDeserializer(ObjectDeserializer<AliasDefinition.Builder> op)
AliasDefinition.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<AliasDefinition> _DESERIALIZER

Json deserializer for AliasDefinition

Method Detail

of

public static AliasDefinition of(java.util.function.Function<AliasDefinition.Builder,ObjectBuilder<AliasDefinition>> fn)

filter

@Nullable
public final Query filter()

API name: filter

indexRouting

@Nullable
public final java.lang.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 java.lang.Boolean isHidden()

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

API name: is_hidden

isWriteIndex

@Nullable
public final java.lang.Boolean isWriteIndex()

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

API name: is_write_index

routing

@Nullable
public final java.lang.String routing()

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

API name: routing

searchRouting

@Nullable
public final java.lang.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)

toBuilder

@Nonnull
public AliasDefinition.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AliasDefinition.Builder,AliasDefinition>

Returns:

a new builder instance.

builder

@Nonnull
public static AliasDefinition.Builder builder()

setupAliasDefinitionDeserializer

protected static void setupAliasDefinitionDeserializer(ObjectDeserializer<AliasDefinition.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object