- All Known Implementing Classes:
public interface IndexAbstraction
An index abstraction is a reference to one or more concrete indices. An index abstraction has a unique name and encapsulates all the
IndexMetadatainstances it is pointing to. Also depending on type it may refer to a single or many concrete indices and may or may not have a write index.
Nested Class SummaryModifier and TypeInterfaceDescription
static classRepresents an alias and groups all
IndexMetadatainstances sharing the same alias name together.
static classRepresents an concrete index and encapsulates its
static enumAn index abstraction type.
Method SummaryModifier and TypeMethodDescription
getType()A write index is a dedicated concrete index, that accepts all the new documents that belong to an index abstraction.
- the type of the index abstraction
- the name of the index abstraction
IndexMetadataof all concrete indices this index abstraction is referring to.
getWriteIndexA 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
getIndices(). An index abstraction may also not have a dedicated write index.
- the write index of this index abstraction or
nullif this index abstraction doesn't have a write index.
getParentDataStream@Nullable IndexAbstraction.DataStream getParentDataStream()
- 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.
- whether this index abstraction is hidden or not
- whether this index abstraction should be treated as a system index or not
isDataStreamRelateddefault boolean isDataStreamRelated()
- whether this index abstraction is related to data streams
- the names of aliases referring to this instance.
nullif aliases can't point to this instance.