Package org.opensearch.client.opensearch.indices.get_alias

Class IndexAliases

java.lang.Object

org.opensearch.client.opensearch.indices.get_alias.IndexAliases

All Implemented Interfaces:

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

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

The alias configuration for an index.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Map<String,AliasDefinition>	aliases()	Required - The map of alias names to their definitions.
static IndexAliases.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static IndexAliases	of(Function<IndexAliases.Builder,ObjectBuilder<IndexAliases>> fn)
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	setupIndexAliasesDeserializer(ObjectDeserializer<IndexAliases.Builder> op)
IndexAliases.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 Details

_DESERIALIZER

public static final JsonpDeserializer<IndexAliases> _DESERIALIZER

Json deserializer for IndexAliases

Method Details

of

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

aliases

@Nonnull
public final Map<String,AliasDefinition> aliases()

Required - The map of alias names to their definitions.

API name: aliases

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 IndexAliases.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<IndexAliases.Builder,IndexAliases>

Returns:

a new builder instance.

builder

@Nonnull
public static IndexAliases.Builder builder()

setupIndexAliasesDeserializer

protected static void setupIndexAliasesDeserializer(ObjectDeserializer<IndexAliases.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object