Package org.opensearch.cluster.metadata

Class IndexAbstraction.Alias

java.lang.Object

org.opensearch.cluster.metadata.IndexAbstraction.Alias

All Implemented Interfaces:

IndexAbstraction

Enclosing interface:

IndexAbstraction

public static class IndexAbstraction.Alias
extends Object
implements IndexAbstraction

Represents an alias and groups all IndexMetadata instances sharing the same alias name together.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.cluster.metadata.IndexAbstraction

IndexAbstraction.Alias, IndexAbstraction.DataStream, IndexAbstraction.Index, IndexAbstraction.Type

Constructor Summary

Constructors

Constructor	Description
Alias(AliasMetadata aliasMetadata, IndexMetadata indexMetadata)

Method Summary

Modifier and Type	Method	Description
void	computeAndValidateAliasProperties()
Iterable<org.opensearch.common.collect.Tuple<String,AliasMetadata>>	getConcreteIndexAndAliasMetadatas()	Returns the unique alias metadata per concrete index.
AliasMetadata	getFirstAliasMetadata()
List<IndexMetadata>	getIndices()
String	getName()
IndexAbstraction.DataStream	getParentDataStream()
IndexAbstraction.Type	getType()
IndexMetadata	getWriteIndex()	A write index is a dedicated concrete index, that accepts all the new documents that belong to an index abstraction.
boolean	isHidden()
boolean	isSystem()

Methods inherited from class java.lang.Object

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

Constructor Details

Alias

public Alias(AliasMetadata aliasMetadata,
 IndexMetadata indexMetadata)

Method Details

getType

public IndexAbstraction.Type getType()

Specified by:

getType in interface IndexAbstraction

Returns:

the type of the index abstraction

getName

public String getName()

Specified by:

getName in interface IndexAbstraction

Returns:

the name of the index abstraction

getIndices

public List<IndexMetadata> getIndices()

Specified by:

getIndices in interface IndexAbstraction

Returns:

All IndexMetadata of all concrete indices this index abstraction is referring to.

getWriteIndex

@Nullable
public IndexMetadata getWriteIndex()

Description copied from interface: IndexAbstraction

A write index is a dedicated concrete index, that accepts all the new documents that belong to an index abstraction.

A write index may also be a regular concrete index of a index abstraction and may therefore also be returned by IndexAbstraction.getIndices(). An index abstraction may also not have a dedicated write index.

Specified by:

getWriteIndex in interface IndexAbstraction

Returns:

the write index of this index abstraction or null if this index abstraction doesn't have a write index.

getParentDataStream

public IndexAbstraction.DataStream getParentDataStream()

Specified by:

getParentDataStream in interface IndexAbstraction

Returns:

the data stream to which this index belongs or null if this is not a concrete index or if it is a concrete index that does not belong to a data stream.

isHidden

public boolean isHidden()

Specified by:

isHidden in interface IndexAbstraction

Returns:

whether this index abstraction is hidden or not

isSystem

public boolean isSystem()

Specified by:

isSystem in interface IndexAbstraction

Returns:

whether this index abstraction should be treated as a system index or not

getConcreteIndexAndAliasMetadatas

public Iterable<org.opensearch.common.collect.Tuple<String,AliasMetadata>> getConcreteIndexAndAliasMetadatas()

Returns the unique alias metadata per concrete index.

(note that although alias can point to the same concrete indices, each alias reference may have its own routing and filters)

getFirstAliasMetadata

public AliasMetadata getFirstAliasMetadata()

computeAndValidateAliasProperties

public void computeAndValidateAliasProperties()