Interface IndexAbstraction
- All Known Implementing Classes:
IndexAbstraction.Alias
,IndexAbstraction.DataStream
,IndexAbstraction.Index
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
IndexMetadata
instances 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 Summary
Nested Classes Modifier and Type Interface Description static class
IndexAbstraction.Alias
Represents an alias and groups allIndexMetadata
instances sharing the same alias name together.static class
IndexAbstraction.DataStream
static class
IndexAbstraction.Index
Represents an concrete index and encapsulates itsIndexMetadata
static class
IndexAbstraction.Type
An index abstraction type. -
Method Summary
Modifier and Type Method Description java.util.List<IndexMetadata>
getIndices()
java.lang.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()
-
Method Details
-
getType
IndexAbstraction.Type getType()- Returns:
- the type of the index abstraction
-
getName
java.lang.String getName()- Returns:
- the name of the index abstraction
-
getIndices
java.util.List<IndexMetadata> getIndices()- Returns:
- All
IndexMetadata
of all concrete indices this index abstraction is referring to.
-
getWriteIndex
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
getIndices()
. An index abstraction may also not have a dedicated write index.- Returns:
- the write index of this index abstraction or
null
if this index abstraction doesn't have a write index.
-
getParentDataStream
- 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
boolean isHidden()- Returns:
- whether this index abstraction is hidden or not
-
isSystem
boolean isSystem()- Returns:
- whether this index abstraction should be treated as a system index or not
-