Module org.elasticsearch.server
Class IndexAbstraction.Alias
java.lang.Object
org.elasticsearch.cluster.metadata.IndexAbstraction.Alias
- All Implemented Interfaces:
IndexAbstraction
- Enclosing interface:
IndexAbstraction
Represents an alias and groups all
IndexMetadata instances sharing the same alias name together.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.cluster.metadata.IndexAbstraction
IndexAbstraction.Alias, IndexAbstraction.ConcreteIndex, IndexAbstraction.Type -
Constructor Summary
ConstructorsConstructorDescriptionAlias(AliasMetadata aliasMetadata, List<IndexMetadata> indexMetadatas) Alias(DataStreamAlias dataStreamAlias, List<Index> indicesOfAllDataStreams, Index writeIndexOfWriteDataStream, List<String> dataStreams) -
Method Summary
Modifier and TypeMethodDescriptionbooleangetFailureIndices(ProjectMetadata metadata) It retrieves the failure indices of an index abstraction given it supports the failure store.getName()getType()getWriteFailureIndex(ProjectMetadata metadata) A write failure index is a dedicated concrete index, that accepts all the new documents that belong to the failure store of an index abstraction.A write index is a dedicated concrete index, that accepts all the new documents that belong to an index abstraction.getWriteIndex(IndexRequest request, ProjectMetadata project) inthashCode()booleanbooleanisHidden()booleanisSystem()Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.cluster.metadata.IndexAbstraction
isFailureIndexOfDataStream
-
Constructor Details
-
Alias
-
Alias
-
-
Method Details
-
getType
- Specified by:
getTypein interfaceIndexAbstraction- Returns:
- the type of the index abstraction
-
getName
- Specified by:
getNamein interfaceIndexAbstraction- Returns:
- the name of the index abstraction
-
getIndices
- Specified by:
getIndicesin interfaceIndexAbstraction- Returns:
- All
Indexof all concrete indices this index abstraction is referring to.
-
getFailureIndices
Description copied from interface:IndexAbstractionIt retrieves the failure indices of an index abstraction given it supports the failure store.- Specified by:
getFailureIndicesin interfaceIndexAbstraction- Parameters:
metadata- certain abstractions require the project matadata to lazily retrieve the failure indices.- Returns:
- All concrete failure indices this index abstraction is referring to. If the failure store is not supported, it returns an empty list.
-
getWriteIndex
Description copied from interface:IndexAbstractionA 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:
getWriteIndexin interfaceIndexAbstraction- Returns:
- the write index of this index abstraction or
nullif this index abstraction doesn't have a write index.
-
getWriteFailureIndex
Description copied from interface:IndexAbstractionA write failure index is a dedicated concrete index, that accepts all the new documents that belong to the failure store of an index abstraction. Only an index abstraction with trueIndexAbstraction.isDataStreamRelated()supports a failure store.- Specified by:
getWriteFailureIndexin interfaceIndexAbstraction- Parameters:
metadata- certain index abstraction require the project metadata to lazily retrieve the failure indices- Returns:
- the write failure index of this index abstraction or
nullif this index abstraction doesn't have a write failure index or it does not support the failure store.
-
getWriteIndex
- Specified by:
getWriteIndexin interfaceIndexAbstraction
-
getParentDataStream
- Specified by:
getParentDataStreamin interfaceIndexAbstraction- Returns:
- the data stream to which this index belongs or
nullif 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:
isHiddenin interfaceIndexAbstraction- Returns:
- whether this index abstraction is hidden or not
-
isSystem
public boolean isSystem()- Specified by:
isSystemin interfaceIndexAbstraction- Returns:
- whether this index abstraction should be treated as a system index or not
-
isDataStreamRelated
public boolean isDataStreamRelated()- Specified by:
isDataStreamRelatedin interfaceIndexAbstraction- Returns:
- whether this index abstraction is related to data streams
-
equals
-
hashCode
public int hashCode()
-