Class IndexAbstraction.DataStream

All Implemented Interfaces:
Enclosing interface:

public static class IndexAbstraction.DataStream extends Object implements IndexAbstraction
  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Specified by:
      getName in interface IndexAbstraction
      the name of the index abstraction
    • getType

      public IndexAbstraction.Type getType()
      Specified by:
      getType in interface IndexAbstraction
      the type of the index abstraction
    • getIndices

      public List<IndexMetadata> getIndices()
      Specified by:
      getIndices in interface IndexAbstraction
      All IndexMetadata of all concrete indices this index abstraction is referring to.
    • getWriteIndex

      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
      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
      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
      whether this index abstraction is hidden or not
    • isSystem

      public boolean isSystem()
      Specified by:
      isSystem in interface IndexAbstraction
      whether this index abstraction should be treated as a system index or not
    • isDataStreamRelated

      public boolean isDataStreamRelated()
      Specified by:
      isDataStreamRelated in interface IndexAbstraction
      whether this index abstraction is related to data streams
    • getDataStream

      public DataStream getDataStream()