Interface SegmentMetadata

  • All Known Implementing Classes:
    SegmentMetadataImpl

    @Private
    public interface SegmentMetadata
    The SegmentMetadata class holds the segment level management information and data statistics.
    • Method Detail

      • getTableName

        @Deprecated
        String getTableName()
        Deprecated.
        Returns the raw table name (without the type suffix).
      • getTimeColumn

        String getTimeColumn()
      • getStartTime

        long getStartTime()
      • getEndTime

        long getEndTime()
      • getTimeGranularity

        org.joda.time.Duration getTimeGranularity()
      • getTimeInterval

        org.joda.time.Interval getTimeInterval()
      • getSchema

        Schema getSchema()
      • getTotalDocs

        int getTotalDocs()
      • getIndexDir

        File getIndexDir()
      • getCreatorName

        @Nullable
        String getCreatorName()
      • getIndexCreationTime

        long getIndexCreationTime()
      • getLastIndexedTimestamp

        long getLastIndexedTimestamp()
        Return the last time a record was indexed in this segment. Applicable for MutableSegments.
        Returns:
        time when the last record was indexed
      • getLatestIngestionTimestamp

        long getLatestIngestionTimestamp()
        Return the latest ingestion timestamp associated with the records indexed in this segment. Applicable for MutableSegments.
        Returns:
        latest timestamp associated with indexed records Long.MIN_VALUE if the stream doesn't provide a timestamp
      • getStartOffset

        String getStartOffset()
      • getEndOffset

        String getEndOffset()
      • getAllColumns

        default Set<String> getAllColumns()
      • removeColumn

        void removeColumn​(String column)
        Removes a column from the segment metadata.
      • toJson

        com.fasterxml.jackson.databind.JsonNode toJson​(@Nullable
                                                       Set<String> columnFilter)
        Converts segment metadata to json.
        Parameters:
        columnFilter - list only the columns in the set. Lists all the columns if the parameter value is null.
        Returns:
        json representation of segment metadata.
      • isMutableSegment

        default boolean isMutableSegment()