HoodieTimeline (hudi-common 0.15.0 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

HoodieActiveTimeline, HoodieArchivedTimeline, HoodieDefaultTimeline
```
public interface HoodieTimeline
extends Serializable
```
HoodieTimeline is a view of meta-data instants in the hoodie table. Instants are specific points in time represented as HoodieInstant.
Timelines are immutable once created and operations create new instance of timelines which filter on the instants and this can be chained.

Since:

0.3.0

See Also:

HoodieTableMetaClient, HoodieDefaultTimeline, HoodieInstant

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLEAN_ACTION`
`static String`	`CLEAN_EXTENSION`
`static String`	`COMMIT_ACTION`
`static String`	`COMMIT_EXTENSION`
`static String`	`COMPACTION_ACTION`
`static String`	`COMPLETED_COMPACTION_SUFFIX`
`static String`	`COMPLETED_EXTENSION`
`static String`	`DELTA_COMMIT_ACTION`
`static String`	`DELTA_COMMIT_EXTENSION`
`static BiPredicate<String,String>`	`EQUALS` Helper methods to compare instants.
`static String`	`FULL_BOOTSTRAP_INSTANT_TS`
`static BiPredicate<String,String>`	`GREATER_THAN`
`static BiPredicate<String,String>`	`GREATER_THAN_OR_EQUALS`
`static String`	`INDEX_COMMIT_EXTENSION`
`static String`	`INDEXING_ACTION`
`static String`	`INFLIGHT_CLEAN_EXTENSION`
`static String`	`INFLIGHT_COMMIT_EXTENSION`
`static String`	`INFLIGHT_COMPACTION_EXTENSION`
`static String`	`INFLIGHT_DELTA_COMMIT_EXTENSION`
`static String`	`INFLIGHT_EXTENSION`
`static String`	`INFLIGHT_INDEX_COMMIT_EXTENSION`
`static String`	`INFLIGHT_LOG_COMPACTION_EXTENSION`
`static String`	`INFLIGHT_REPLACE_COMMIT_EXTENSION`
`static String`	`INFLIGHT_RESTORE_EXTENSION`
`static String`	`INFLIGHT_ROLLBACK_EXTENSION`
`static String`	`INFLIGHT_SAVE_SCHEMA_ACTION_EXTENSION`
`static String`	`INFLIGHT_SAVEPOINT_EXTENSION`
`static String`	`INIT_INSTANT_TS`
`static String`	`INVALID_INSTANT_TS`
`static BiPredicate<String,String>`	`LESSER_THAN`
`static BiPredicate<String,String>`	`LESSER_THAN_OR_EQUALS`
`static String`	`LOG_COMPACTION_ACTION`
`static String`	`METADATA_BOOTSTRAP_INSTANT_TS`
`static String`	`REPLACE_COMMIT_ACTION`
`static String`	`REPLACE_COMMIT_EXTENSION`
`static String`	`REQUESTED_CLEAN_EXTENSION`
`static String`	`REQUESTED_COMMIT_EXTENSION`
`static String`	`REQUESTED_COMPACTION_EXTENSION`
`static String`	`REQUESTED_COMPACTION_SUFFIX`
`static String`	`REQUESTED_DELTA_COMMIT_EXTENSION`
`static String`	`REQUESTED_EXTENSION`
`static String`	`REQUESTED_INDEX_COMMIT_EXTENSION`
`static String`	`REQUESTED_LOG_COMPACTION_EXTENSION`
`static String`	`REQUESTED_LOG_COMPACTION_SUFFIX`
`static String`	`REQUESTED_REPLACE_COMMIT_EXTENSION`
`static String`	`REQUESTED_RESTORE_EXTENSION`
`static String`	`REQUESTED_ROLLBACK_EXTENSION`
`static String`	`REQUESTED_SAVE_SCHEMA_ACTION_EXTENSION`
`static String`	`RESTORE_ACTION`
`static String`	`RESTORE_EXTENSION`
`static String`	`ROLLBACK_ACTION`
`static String`	`ROLLBACK_EXTENSION`
`static String`	`SAVE_SCHEMA_ACTION_EXTENSION`
`static String`	`SAVEPOINT_ACTION`
`static String`	`SAVEPOINT_EXTENSION`
`static String`	`SCHEMA_COMMIT_ACTION`
`static String[]`	`VALID_ACTIONS_IN_TIMELINE`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static boolean`	`compareTimestamps(String commit1, BiPredicate<String,String> predicateToApply, String commit2)`
`boolean`	`containsInstant(HoodieInstant instant)`
`boolean`	`containsInstant(String ts)`
`boolean`	`containsOrBeforeTimelineStarts(String ts)`
`int`	`countInstants()`
`boolean`	`empty()` If the timeline has any instants.
`HoodieTimeline`	`filter(Predicate<HoodieInstant> filter)` Custom Filter of Instants.
`HoodieTimeline`	`filterCompletedAndCompactionInstants()` Filter this timeline to just include the completed + compaction (inflight + requested) instants A RT filesystem view is constructed with this timeline so that file-slice after pending compaction-requested instant-time is also considered valid.
`HoodieTimeline`	`filterCompletedIndexTimeline()` Filter this timeline to just include completed index instants.
`HoodieTimeline`	`filterCompletedInstants()` Filter this timeline to just include the completed instants.
`HoodieTimeline`	`filterCompletedInstantsOrRewriteTimeline()` Timeline to just include completed commits or all rewrites like compaction, logcompaction and replace actions.
`HoodieTimeline`	`filterCompletedOrMajorOrMinorCompactionInstants()`
`HoodieTimeline`	`filterInflights()` Filter this timeline to just include the in-flights.
`HoodieTimeline`	`filterInflightsAndRequested()` Filter this timeline to include requested and in-flights.
`HoodieTimeline`	`filterPendingCompactionTimeline()` Filter this timeline to just include requested and inflight compaction instants.
`HoodieTimeline`	`filterPendingExcludingCompaction()` Filter this timeline to just include the in-flights excluding compaction instants.
`HoodieTimeline`	`filterPendingExcludingLogCompaction()` Filter this timeline to just include the in-flights excluding logcompaction instants.
`HoodieTimeline`	`filterPendingExcludingMajorAndMinorCompaction()` Filter this timeline to just include the in-flights excluding major and minor compaction instants.
`HoodieTimeline`	`filterPendingIndexTimeline()` Filter this timeline to just include requested and inflight index instants.
`HoodieTimeline`	`filterPendingLogCompactionTimeline()` Filter this timeline to just include requested and inflight log compaction instants.
`HoodieTimeline`	`filterPendingMajorOrMinorCompactionTimeline()` Filter this timeline to just include requested and inflight from both major and minor compaction instants.
`HoodieTimeline`	`filterPendingReplaceTimeline()` Filter this timeline to just include requested and inflight replacecommit instants.
`HoodieTimeline`	`filterPendingRollbackTimeline()` Filter this timeline to include pending rollbacks.
`HoodieTimeline`	`filterRequestedRollbackTimeline()` Filter this timeline for requested rollbacks.
`Option<HoodieInstant>`	`findInstantBefore(String instantTime)` Finds the instant before specified time.
`HoodieTimeline`	`findInstantsAfter(String instantTime)` Create a new Timeline with all the instants after startTs.
`HoodieTimeline`	`findInstantsAfter(String instantTime, int numCommits)` Create a new Timeline with all the instants after startTs.
`HoodieTimeline`	`findInstantsAfterOrEquals(String commitTime, int numCommits)` Create a new Timeline with all the instants after startTs.
`HoodieTimeline`	`findInstantsBefore(String instantTime)` Create a new Timeline with all instants before specified time.
`HoodieTimeline`	`findInstantsBeforeOrEquals(String instantTime)` Create new timeline with all instants before or equals specified time.
`HoodieTimeline`	`findInstantsInClosedRange(String startTs, String endTs)` Create a new Timeline with instants after or equals startTs and before or on endTs.
`HoodieTimeline`	`findInstantsInRange(String startTs, String endTs)` Create a new Timeline with instants after startTs and before or on endTs.
`HoodieTimeline`	`findInstantsInRangeByStateTransitionTime(String startTs, String endTs)` ` Create a new Timeline with instants after startTs and before or on endTs by state transition timestamp of actions.
`HoodieTimeline`	`findInstantsModifiedAfterByStateTransitionTime(String instantTime)` Create new timeline with all instants that were modified after specified time.
`Option<HoodieInstant>`	`firstInstant()`
`Option<HoodieInstant>`	`firstInstant(String action, HoodieInstant.State state)`
`static HoodieInstant`	`getCleanInflightInstant(String timestamp)`
`static HoodieInstant`	`getCleanRequestedInstant(String timestamp)`
`static String`	`getCommitFromCommitFile(String commitFileName)`
`static HoodieInstant`	`getCompactionInflightInstant(String timestamp)`
`static HoodieInstant`	`getCompactionRequestedInstant(String timestamp)`
`static HoodieInstant`	`getCompletedInstant(HoodieInstant instant)`
`HoodieTimeline`	`getCompletedReplaceTimeline()` Timeline to just include replace instants that have valid (commit/deltacommit) actions.
`HoodieTimeline`	`getContiguousCompletedWriteTimeline()` Timeline to just include commits (commit/deltacommit), compaction and replace actions that are completed and contiguous.
`Option<HoodieInstant>`	`getFirstNonSavepointCommit()` First non-savepoint commit in the active data timeline.
`Option<HoodieInstant>`	`getFirstPendingClusterInstant()` get the least recent pending cluster commit if present
`static HoodieInstant`	`getIndexInflightInstant(String timestamp)`
`static HoodieInstant`	`getIndexRequestedInstant(String timestamp)`
`static HoodieInstant`	`getInflightInstant(HoodieInstant instant, HoodieTableMetaClient metaClient)` Returns the inflight instant corresponding to the instant being passed.
`Option<byte[]>`	`getInstantDetails(HoodieInstant instant)` Read the completed instant details.
`List<HoodieInstant>`	`getInstants()`
`Stream<HoodieInstant>`	`getInstantsAsStream()`
`Stream<HoodieInstant>`	`getInstantsOrderedByStateTransitionTime()` Get the stream of instants in order by state transition timestamp of actions.
`Option<HoodieInstant>`	`getLastClusteringInstant()` get the most recent cluster commit if present
`Option<HoodieInstant>`	`getLastPendingClusterInstant()` get the most recent pending cluster commit if present
`static HoodieInstant`	`getLogCompactionInflightInstant(String timestamp)`
`static HoodieInstant`	`getLogCompactionRequestedInstant(String timestamp)`
`static HoodieInstant`	`getReplaceCommitInflightInstant(String timestamp)`
`static HoodieInstant`	`getReplaceCommitRequestedInstant(String timestamp)`
`static HoodieInstant`	`getRequestedInstant(HoodieInstant instant)`
`static HoodieInstant`	`getRestoreRequestedInstant(HoodieInstant instant)`
`Stream<HoodieInstant>`	`getReverseOrderedInstants()`
`static HoodieInstant`	`getRollbackRequestedInstant(HoodieInstant instant)`
`String`	`getTimelineHash()` Get hash of timeline.
`HoodieTimeline`	`getWriteTimeline()` Timeline to just include commits (commit/deltacommit), compaction and replace actions.
`boolean`	`isBeforeTimelineStarts(String ts)`
`boolean`	`isEmpty(HoodieInstant instant)`
`static boolean`	`isInClosedRange(String timestamp, String startTs, String endTs)` Return true if specified timestamp is in range [startTs, endTs].
`static boolean`	`isInRange(String timestamp, String startTs, String endTs)` Return true if specified timestamp is in range (startTs, endTs].
`boolean`	`isPendingClusterInstant(String instantTime)` return true if instant is a pending clustering commit, otherwise false
`Option<HoodieInstant>`	`lastInstant()`
`static String`	`makeCleanerFileName(String instant)`
`static String`	`makeCommitFileName(String instantTime)`
`static String`	`makeDeltaFileName(String instantTime)`
`static String`	`makeFileNameAsComplete(String fileName)`
`static String`	`makeFileNameAsInflight(String fileName)`
`static String`	`makeIndexCommitFileName(String instant)`
`static String`	`makeInflightCleanerFileName(String instant)`
`static String`	`makeInflightCommitFileName(String instantTime)`
`static String`	`makeInflightCompactionFileName(String instantTime)`
`static String`	`makeInflightDeltaFileName(String instantTime)`
`static String`	`makeInflightIndexFileName(String instant)`
`static String`	`makeInflightLogCompactionFileName(String instantTime)`
`static String`	`makeInflightReplaceFileName(String instant)`
`static String`	`makeInflightRestoreFileName(String instant)`
`static String`	`makeInflightRollbackFileName(String instant)`
`static String`	`makeInflightSavePointFileName(String instantTime)`
`static String`	`makeInflightSchemaFileName(String instantTime)`
`static String`	`makeReplaceFileName(String instant)`
`static String`	`makeRequestedCleanerFileName(String instant)`
`static String`	`makeRequestedCommitFileName(String instantTime)`
`static String`	`makeRequestedCompactionFileName(String instantTime)`
`static String`	`makeRequestedDeltaFileName(String instantTime)`
`static String`	`makeRequestedIndexFileName(String instant)`
`static String`	`makeRequestedLogCompactionFileName(String instantTime)`
`static String`	`makeRequestedReplaceFileName(String instant)`
`static String`	`makeRequestedRestoreFileName(String instant)`
`static String`	`makeRequestedRollbackFileName(String instant)`
`static String`	`makeRequestSchemaFileName(String instantTime)`
`static String`	`makeRestoreFileName(String instant)`
`static String`	`makeRollbackFileName(String instant)`
`static String`	`makeSavePointFileName(String instantTime)`
`static String`	`makeSchemaFileName(String instantTime)`
`Option<HoodieInstant>`	`nthFromLastInstant(int n)`
`Option<HoodieInstant>`	`nthInstant(int n)`

- Field Detail
  - COMMIT_ACTION
```
static final String COMMIT_ACTION
```
    See Also:
    
    Constant Field Values
  - DELTA_COMMIT_ACTION
```
static final String DELTA_COMMIT_ACTION
```
    See Also:
    
    Constant Field Values
  - CLEAN_ACTION
```
static final String CLEAN_ACTION
```
    See Also:
    
    Constant Field Values
  - ROLLBACK_ACTION
```
static final String ROLLBACK_ACTION
```
    See Also:
    
    Constant Field Values
  - SAVEPOINT_ACTION
```
static final String SAVEPOINT_ACTION
```
    See Also:
    
    Constant Field Values
  - REPLACE_COMMIT_ACTION
```
static final String REPLACE_COMMIT_ACTION
```
    See Also:
    
    Constant Field Values
  - INFLIGHT_EXTENSION
```
static final String INFLIGHT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - COMPACTION_ACTION
```
static final String COMPACTION_ACTION
```
    See Also:
    
    Constant Field Values
  - LOG_COMPACTION_ACTION
```
static final String LOG_COMPACTION_ACTION
```
    See Also:
    
    Constant Field Values
  - REQUESTED_EXTENSION
```
static final String REQUESTED_EXTENSION
```
    See Also:
    
    Constant Field Values
  - COMPLETED_EXTENSION
```
static final String COMPLETED_EXTENSION
```
    See Also:
    
    Constant Field Values
  - RESTORE_ACTION
```
static final String RESTORE_ACTION
```
    See Also:
    
    Constant Field Values
  - INDEXING_ACTION
```
static final String INDEXING_ACTION
```
    See Also:
    
    Constant Field Values
  - SCHEMA_COMMIT_ACTION
```
static final String SCHEMA_COMMIT_ACTION
```
    See Also:
    
    Constant Field Values
  - VALID_ACTIONS_IN_TIMELINE
```
static final String[] VALID_ACTIONS_IN_TIMELINE
```
  - COMMIT_EXTENSION
```
static final String COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - DELTA_COMMIT_EXTENSION
```
static final String DELTA_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - CLEAN_EXTENSION
```
static final String CLEAN_EXTENSION
```
    See Also:
    
    Constant Field Values
  - ROLLBACK_EXTENSION
```
static final String ROLLBACK_EXTENSION
```
    See Also:
    
    Constant Field Values
  - SAVEPOINT_EXTENSION
```
static final String SAVEPOINT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - INFLIGHT_COMMIT_EXTENSION
```
static final String INFLIGHT_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - REQUESTED_COMMIT_EXTENSION
```
static final String REQUESTED_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - REQUESTED_DELTA_COMMIT_EXTENSION
```
static final String REQUESTED_DELTA_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - INFLIGHT_DELTA_COMMIT_EXTENSION
```
static final String INFLIGHT_DELTA_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - INFLIGHT_CLEAN_EXTENSION
```
static final String INFLIGHT_CLEAN_EXTENSION
```
    See Also:
    
    Constant Field Values
  - REQUESTED_CLEAN_EXTENSION
```
static final String REQUESTED_CLEAN_EXTENSION
```
    See Also:
    
    Constant Field Values
  - INFLIGHT_ROLLBACK_EXTENSION
```
static final String INFLIGHT_ROLLBACK_EXTENSION
```
    See Also:
    
    Constant Field Values
  - REQUESTED_ROLLBACK_EXTENSION
```
static final String REQUESTED_ROLLBACK_EXTENSION
```
    See Also:
    
    Constant Field Values
  - INFLIGHT_SAVEPOINT_EXTENSION
```
static final String INFLIGHT_SAVEPOINT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - REQUESTED_COMPACTION_SUFFIX
```
static final String REQUESTED_COMPACTION_SUFFIX
```
  - COMPLETED_COMPACTION_SUFFIX
```
static final String COMPLETED_COMPACTION_SUFFIX
```
  - REQUESTED_COMPACTION_EXTENSION
```
static final String REQUESTED_COMPACTION_EXTENSION
```
  - INFLIGHT_COMPACTION_EXTENSION
```
static final String INFLIGHT_COMPACTION_EXTENSION
```
  - REQUESTED_RESTORE_EXTENSION
```
static final String REQUESTED_RESTORE_EXTENSION
```
    See Also:
    
    Constant Field Values
  - INFLIGHT_RESTORE_EXTENSION
```
static final String INFLIGHT_RESTORE_EXTENSION
```
    See Also:
    
    Constant Field Values
  - RESTORE_EXTENSION
```
static final String RESTORE_EXTENSION
```
    See Also:
    
    Constant Field Values
  - INFLIGHT_REPLACE_COMMIT_EXTENSION
```
static final String INFLIGHT_REPLACE_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - REQUESTED_REPLACE_COMMIT_EXTENSION
```
static final String REQUESTED_REPLACE_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - REPLACE_COMMIT_EXTENSION
```
static final String REPLACE_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - INFLIGHT_INDEX_COMMIT_EXTENSION
```
static final String INFLIGHT_INDEX_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - REQUESTED_INDEX_COMMIT_EXTENSION
```
static final String REQUESTED_INDEX_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - INDEX_COMMIT_EXTENSION
```
static final String INDEX_COMMIT_EXTENSION
```
    See Also:
    
    Constant Field Values
  - SAVE_SCHEMA_ACTION_EXTENSION
```
static final String SAVE_SCHEMA_ACTION_EXTENSION
```
    See Also:
    
    Constant Field Values
  - INFLIGHT_SAVE_SCHEMA_ACTION_EXTENSION
```
static final String INFLIGHT_SAVE_SCHEMA_ACTION_EXTENSION
```
    See Also:
    
    Constant Field Values
  - REQUESTED_SAVE_SCHEMA_ACTION_EXTENSION
```
static final String REQUESTED_SAVE_SCHEMA_ACTION_EXTENSION
```
    See Also:
    
    Constant Field Values
  - REQUESTED_LOG_COMPACTION_SUFFIX
```
static final String REQUESTED_LOG_COMPACTION_SUFFIX
```
  - REQUESTED_LOG_COMPACTION_EXTENSION
```
static final String REQUESTED_LOG_COMPACTION_EXTENSION
```
  - INFLIGHT_LOG_COMPACTION_EXTENSION
```
static final String INFLIGHT_LOG_COMPACTION_EXTENSION
```
  - INVALID_INSTANT_TS
```
static final String INVALID_INSTANT_TS
```
    See Also:
    
    Constant Field Values
  - INIT_INSTANT_TS
```
static final String INIT_INSTANT_TS
```
    See Also:
    
    Constant Field Values
  - METADATA_BOOTSTRAP_INSTANT_TS
```
static final String METADATA_BOOTSTRAP_INSTANT_TS
```
    See Also:
    
    Constant Field Values
  - FULL_BOOTSTRAP_INSTANT_TS
```
static final String FULL_BOOTSTRAP_INSTANT_TS
```
    See Also:
    
    Constant Field Values
  - EQUALS
```
static final BiPredicate<String,String> EQUALS
```
    Helper methods to compare instants.
  - GREATER_THAN_OR_EQUALS
```
static final BiPredicate<String,String> GREATER_THAN_OR_EQUALS
```
  - GREATER_THAN
```
static final BiPredicate<String,String> GREATER_THAN
```
  - LESSER_THAN_OR_EQUALS
```
static final BiPredicate<String,String> LESSER_THAN_OR_EQUALS
```
  - LESSER_THAN
```
static final BiPredicate<String,String> LESSER_THAN
```
- Method Detail
  - filterInflights
```
HoodieTimeline filterInflights()
```
    Filter this timeline to just include the in-flights.
    
    Returns:
    
    New instance of HoodieTimeline with just in-flights
  - filterInflightsAndRequested
```
HoodieTimeline filterInflightsAndRequested()
```
    Filter this timeline to include requested and in-flights.
    
    Returns:
    
    New instance of HoodieTimeline with just in-flights and requested instants
  - filterPendingExcludingCompaction
```
HoodieTimeline filterPendingExcludingCompaction()
```
    Filter this timeline to just include the in-flights excluding compaction instants.
    
    Returns:
    
    New instance of HoodieTimeline with just in-flights excluding compaction instants
  - filterPendingExcludingLogCompaction
```
HoodieTimeline filterPendingExcludingLogCompaction()
```
    Filter this timeline to just include the in-flights excluding logcompaction instants.
    
    Returns:
    
    New instance of HoodieTimeline with just in-flights excluding compaction instants
  - filterPendingExcludingMajorAndMinorCompaction
```
HoodieTimeline filterPendingExcludingMajorAndMinorCompaction()
```
    Filter this timeline to just include the in-flights excluding major and minor compaction instants.
    
    Returns:
    
    New instance of HoodieTimeline with just in-flights excluding major and minor compaction instants
  - filterCompletedInstants
```
HoodieTimeline filterCompletedInstants()
```
    Filter this timeline to just include the completed instants.
    
    Returns:
    
    New instance of HoodieTimeline with just completed instants
  - filterCompletedAndCompactionInstants
```
HoodieTimeline filterCompletedAndCompactionInstants()
```
    Filter this timeline to just include the completed + compaction (inflight + requested) instants A RT filesystem view is constructed with this timeline so that file-slice after pending compaction-requested instant-time is also considered valid. A RT file-system view for reading must then merge the file-slices before and after pending compaction instant so that all delta-commits are read.
    
    Returns:
    
    New instance of HoodieTimeline with just completed instants
  - filterCompletedOrMajorOrMinorCompactionInstants
```
HoodieTimeline filterCompletedOrMajorOrMinorCompactionInstants()
```
  - filterCompletedInstantsOrRewriteTimeline
```
HoodieTimeline filterCompletedInstantsOrRewriteTimeline()
```
    Timeline to just include completed commits or all rewrites like compaction, logcompaction and replace actions.
    
    Returns:
  - getWriteTimeline
```
HoodieTimeline getWriteTimeline()
```
    Timeline to just include commits (commit/deltacommit), compaction and replace actions.
    
    Returns:
  - getContiguousCompletedWriteTimeline
```
HoodieTimeline getContiguousCompletedWriteTimeline()
```
    Timeline to just include commits (commit/deltacommit), compaction and replace actions that are completed and contiguous. For example, if timeline is [C0.completed, C1.completed, C2.completed, C3.inflight, C4.completed]. Then, a timeline of [C0.completed, C1.completed, C2.completed] will be returned.
    
    Returns:
  - getCompletedReplaceTimeline
```
HoodieTimeline getCompletedReplaceTimeline()
```
    Timeline to just include replace instants that have valid (commit/deltacommit) actions.
    
    Returns:
  - filterPendingCompactionTimeline
```
HoodieTimeline filterPendingCompactionTimeline()
```
    Filter this timeline to just include requested and inflight compaction instants.
    
    Returns:
  - filterPendingLogCompactionTimeline
```
HoodieTimeline filterPendingLogCompactionTimeline()
```
    Filter this timeline to just include requested and inflight log compaction instants.
    
    Returns:
  - filterPendingMajorOrMinorCompactionTimeline
```
HoodieTimeline filterPendingMajorOrMinorCompactionTimeline()
```
    Filter this timeline to just include requested and inflight from both major and minor compaction instants.
    
    Returns:
  - filterPendingReplaceTimeline
```
HoodieTimeline filterPendingReplaceTimeline()
```
    Filter this timeline to just include requested and inflight replacecommit instants.
  - filterPendingRollbackTimeline
```
HoodieTimeline filterPendingRollbackTimeline()
```
    Filter this timeline to include pending rollbacks.
  - filterRequestedRollbackTimeline
```
HoodieTimeline filterRequestedRollbackTimeline()
```
    Filter this timeline for requested rollbacks.
  - findInstantsAfterOrEquals
```
HoodieTimeline findInstantsAfterOrEquals(String commitTime,
                                         int numCommits)
```
    Create a new Timeline with all the instants after startTs.
  - findInstantsInRange
```
HoodieTimeline findInstantsInRange(String startTs,
                                   String endTs)
```
    Create a new Timeline with instants after startTs and before or on endTs.
  - findInstantsInClosedRange
```
HoodieTimeline findInstantsInClosedRange(String startTs,
                                         String endTs)
```
    Create a new Timeline with instants after or equals startTs and before or on endTs.
  - findInstantsInRangeByStateTransitionTime
```
HoodieTimeline findInstantsInRangeByStateTransitionTime(String startTs,
                                                        String endTs)
```
    ` Create a new Timeline with instants after startTs and before or on endTs by state transition timestamp of actions.
  - findInstantsModifiedAfterByStateTransitionTime
```
HoodieTimeline findInstantsModifiedAfterByStateTransitionTime(String instantTime)
```
    Create new timeline with all instants that were modified after specified time.
  - findInstantsAfter
```
HoodieTimeline findInstantsAfter(String instantTime,
                                 int numCommits)
```
    Create a new Timeline with all the instants after startTs.
  - findInstantsAfter
```
HoodieTimeline findInstantsAfter(String instantTime)
```
    Create a new Timeline with all the instants after startTs.
  - findInstantsBefore
```
HoodieTimeline findInstantsBefore(String instantTime)
```
    Create a new Timeline with all instants before specified time.
  - findInstantBefore
```
Option<HoodieInstant> findInstantBefore(String instantTime)
```
    Finds the instant before specified time.
  - findInstantsBeforeOrEquals
```
HoodieTimeline findInstantsBeforeOrEquals(String instantTime)
```
    Create new timeline with all instants before or equals specified time.
  - filter
```
HoodieTimeline filter(Predicate<HoodieInstant> filter)
```
    Custom Filter of Instants.
  - filterPendingIndexTimeline
```
HoodieTimeline filterPendingIndexTimeline()
```
    Filter this timeline to just include requested and inflight index instants.
  - filterCompletedIndexTimeline
```
HoodieTimeline filterCompletedIndexTimeline()
```
    Filter this timeline to just include completed index instants.
  - empty
```
boolean empty()
```
    If the timeline has any instants.
    
    Returns:
    
    true if timeline is empty
  - countInstants
```
int countInstants()
```
    Returns:
    
    total number of completed instants
  - firstInstant
```
Option<HoodieInstant> firstInstant()
```
    Returns:
    
    first completed instant if available
  - firstInstant
```
Option<HoodieInstant> firstInstant(String action,
                                   HoodieInstant.State state)
```
    Parameters:
    
    action - Instant action String.
    
    state - Instant State.
    
    Returns:
    
    first instant of a specific action and state if available
  - nthInstant
```
Option<HoodieInstant> nthInstant(int n)
```
    Returns:
    
    nth completed instant from the first completed instant
  - lastInstant
```
Option<HoodieInstant> lastInstant()
```
    Returns:
    
    last completed instant if available
  - getTimelineHash
```
String getTimelineHash()
```
    Get hash of timeline.
    
    Returns:
  - nthFromLastInstant
```
Option<HoodieInstant> nthFromLastInstant(int n)
```
    Returns:
    
    nth completed instant going back from the last completed instant
  - containsInstant
```
boolean containsInstant(HoodieInstant instant)
```
    Returns:
    
    true if the passed instant is present as a completed instant on the timeline
  - containsInstant
```
boolean containsInstant(String ts)
```
    Returns:
    
    true if the passed instant is present as a completed instant on the timeline
  - containsOrBeforeTimelineStarts
```
boolean containsOrBeforeTimelineStarts(String ts)
```
    Returns:
    
    true if the passed instant is present as a completed instant on the timeline or if the instant is before the first completed instant in the timeline
  - getInstantsAsStream
```
Stream<HoodieInstant> getInstantsAsStream()
```
    Returns:
    
    Get the stream of completed instants
  - getInstants
```
List<HoodieInstant> getInstants()
```
    Returns:
    
    Get tht list of instants
  - getReverseOrderedInstants
```
Stream<HoodieInstant> getReverseOrderedInstants()
```
    Returns:
    
    Get the stream of completed instants in reverse order TODO Change code references to getInstants() that reverse the instants later on to use this method instead.
  - getInstantsOrderedByStateTransitionTime
```
Stream<HoodieInstant> getInstantsOrderedByStateTransitionTime()
```
    Get the stream of instants in order by state transition timestamp of actions.
  - isBeforeTimelineStarts
```
boolean isBeforeTimelineStarts(String ts)
```
    Returns:
    
    true if the passed in instant is before the first completed instant in the timeline
  - getFirstNonSavepointCommit
```
Option<HoodieInstant> getFirstNonSavepointCommit()
```
    First non-savepoint commit in the active data timeline. Examples: 1. An active data timeline C1, C2, C3, C4, C5 returns C1. 2. If archival is allowed beyond savepoint and let's say C1, C2, C4 have been archived while C3, C5 have been savepointed, then for the data timeline C3, C3_Savepoint, C5, C5_Savepoint, C6, C7 returns C6.
  - getLastClusteringInstant
```
Option<HoodieInstant> getLastClusteringInstant()
```
    get the most recent cluster commit if present
  - getLastPendingClusterInstant
```
Option<HoodieInstant> getLastPendingClusterInstant()
```
    get the most recent pending cluster commit if present
  - getFirstPendingClusterInstant
```
Option<HoodieInstant> getFirstPendingClusterInstant()
```
    get the least recent pending cluster commit if present
  - isPendingClusterInstant
```
boolean isPendingClusterInstant(String instantTime)
```
    return true if instant is a pending clustering commit, otherwise false
  - getInstantDetails
```
Option<byte[]> getInstantDetails(HoodieInstant instant)
```
    Read the completed instant details.
  - isEmpty
```
boolean isEmpty(HoodieInstant instant)
```
  - compareTimestamps
```
static boolean compareTimestamps(String commit1,
                                 BiPredicate<String,String> predicateToApply,
                                 String commit2)
```
  - isInRange
```
static boolean isInRange(String timestamp,
                         String startTs,
                         String endTs)
```
    Return true if specified timestamp is in range (startTs, endTs].
  - isInClosedRange
```
static boolean isInClosedRange(String timestamp,
                               String startTs,
                               String endTs)
```
    Return true if specified timestamp is in range [startTs, endTs].
  - getCompletedInstant
```
static HoodieInstant getCompletedInstant(HoodieInstant instant)
```
  - getRequestedInstant
```
static HoodieInstant getRequestedInstant(HoodieInstant instant)
```
  - getCleanRequestedInstant
```
static HoodieInstant getCleanRequestedInstant(String timestamp)
```
  - getCleanInflightInstant
```
static HoodieInstant getCleanInflightInstant(String timestamp)
```
  - getCompactionRequestedInstant
```
static HoodieInstant getCompactionRequestedInstant(String timestamp)
```
  - getCompactionInflightInstant
```
static HoodieInstant getCompactionInflightInstant(String timestamp)
```
  - getLogCompactionRequestedInstant
```
static HoodieInstant getLogCompactionRequestedInstant(String timestamp)
```
  - getLogCompactionInflightInstant
```
static HoodieInstant getLogCompactionInflightInstant(String timestamp)
```
  - getReplaceCommitRequestedInstant
```
static HoodieInstant getReplaceCommitRequestedInstant(String timestamp)
```
  - getReplaceCommitInflightInstant
```
static HoodieInstant getReplaceCommitInflightInstant(String timestamp)
```
  - getRollbackRequestedInstant
```
static HoodieInstant getRollbackRequestedInstant(HoodieInstant instant)
```
  - getRestoreRequestedInstant
```
static HoodieInstant getRestoreRequestedInstant(HoodieInstant instant)
```
  - getIndexRequestedInstant
```
static HoodieInstant getIndexRequestedInstant(String timestamp)
```
  - getIndexInflightInstant
```
static HoodieInstant getIndexInflightInstant(String timestamp)
```
  - getInflightInstant
```
static HoodieInstant getInflightInstant(HoodieInstant instant,
                                        HoodieTableMetaClient metaClient)
```
    Returns the inflight instant corresponding to the instant being passed. Takes care of changes in action names between inflight and completed instants (compaction <=> commit) and (logcompaction <==> deltacommit).
    
    Parameters:
    
    instant - Hoodie Instant
    
    metaClient - Hoodie metaClient to fetch tableType and fileSystem.
    
    Returns:
    
    Inflight Hoodie Instant
  - makeCommitFileName
```
static String makeCommitFileName(String instantTime)
```
  - makeInflightCommitFileName
```
static String makeInflightCommitFileName(String instantTime)
```
  - makeRequestedCommitFileName
```
static String makeRequestedCommitFileName(String instantTime)
```
  - makeCleanerFileName
```
static String makeCleanerFileName(String instant)
```
  - makeRequestedCleanerFileName
```
static String makeRequestedCleanerFileName(String instant)
```
  - makeInflightCleanerFileName
```
static String makeInflightCleanerFileName(String instant)
```
  - makeRollbackFileName
```
static String makeRollbackFileName(String instant)
```
  - makeRequestedRollbackFileName
```
static String makeRequestedRollbackFileName(String instant)
```
  - makeRequestedRestoreFileName
```
static String makeRequestedRestoreFileName(String instant)
```
  - makeInflightRollbackFileName
```
static String makeInflightRollbackFileName(String instant)
```
  - makeInflightSavePointFileName
```
static String makeInflightSavePointFileName(String instantTime)
```
  - makeSavePointFileName
```
static String makeSavePointFileName(String instantTime)
```
  - makeInflightDeltaFileName
```
static String makeInflightDeltaFileName(String instantTime)
```
  - makeRequestedDeltaFileName
```
static String makeRequestedDeltaFileName(String instantTime)
```
  - makeInflightCompactionFileName
```
static String makeInflightCompactionFileName(String instantTime)
```
  - makeRequestedCompactionFileName
```
static String makeRequestedCompactionFileName(String instantTime)
```
  - makeInflightLogCompactionFileName
```
static String makeInflightLogCompactionFileName(String instantTime)
```
  - makeRequestedLogCompactionFileName
```
static String makeRequestedLogCompactionFileName(String instantTime)
```
  - makeRestoreFileName
```
static String makeRestoreFileName(String instant)
```
  - makeInflightRestoreFileName
```
static String makeInflightRestoreFileName(String instant)
```
  - makeReplaceFileName
```
static String makeReplaceFileName(String instant)
```
  - makeInflightReplaceFileName
```
static String makeInflightReplaceFileName(String instant)
```
  - makeRequestedReplaceFileName
```
static String makeRequestedReplaceFileName(String instant)
```
  - makeDeltaFileName
```
static String makeDeltaFileName(String instantTime)
```
  - getCommitFromCommitFile
```
static String getCommitFromCommitFile(String commitFileName)
```
  - makeFileNameAsComplete
```
static String makeFileNameAsComplete(String fileName)
```
  - makeFileNameAsInflight
```
static String makeFileNameAsInflight(String fileName)
```
  - makeIndexCommitFileName
```
static String makeIndexCommitFileName(String instant)
```
  - makeInflightIndexFileName
```
static String makeInflightIndexFileName(String instant)
```
  - makeRequestedIndexFileName
```
static String makeRequestedIndexFileName(String instant)
```
  - makeSchemaFileName
```
static String makeSchemaFileName(String instantTime)
```
  - makeInflightSchemaFileName
```
static String makeInflightSchemaFileName(String instantTime)
```
  - makeRequestSchemaFileName
```
static String makeRequestSchemaFileName(String instantTime)
```

Interface HoodieTimeline

Field Summary

Method Summary

Field Detail

COMMIT_ACTION

DELTA_COMMIT_ACTION

CLEAN_ACTION

ROLLBACK_ACTION

SAVEPOINT_ACTION

REPLACE_COMMIT_ACTION

INFLIGHT_EXTENSION

COMPACTION_ACTION

LOG_COMPACTION_ACTION

REQUESTED_EXTENSION

COMPLETED_EXTENSION

RESTORE_ACTION

INDEXING_ACTION

SCHEMA_COMMIT_ACTION

VALID_ACTIONS_IN_TIMELINE

COMMIT_EXTENSION

DELTA_COMMIT_EXTENSION

CLEAN_EXTENSION

ROLLBACK_EXTENSION

SAVEPOINT_EXTENSION

INFLIGHT_COMMIT_EXTENSION

REQUESTED_COMMIT_EXTENSION

REQUESTED_DELTA_COMMIT_EXTENSION

INFLIGHT_DELTA_COMMIT_EXTENSION

INFLIGHT_CLEAN_EXTENSION

REQUESTED_CLEAN_EXTENSION

INFLIGHT_ROLLBACK_EXTENSION

REQUESTED_ROLLBACK_EXTENSION

INFLIGHT_SAVEPOINT_EXTENSION

REQUESTED_COMPACTION_SUFFIX

COMPLETED_COMPACTION_SUFFIX

REQUESTED_COMPACTION_EXTENSION

INFLIGHT_COMPACTION_EXTENSION

REQUESTED_RESTORE_EXTENSION

INFLIGHT_RESTORE_EXTENSION

RESTORE_EXTENSION

INFLIGHT_REPLACE_COMMIT_EXTENSION

REQUESTED_REPLACE_COMMIT_EXTENSION

REPLACE_COMMIT_EXTENSION

INFLIGHT_INDEX_COMMIT_EXTENSION

REQUESTED_INDEX_COMMIT_EXTENSION

INDEX_COMMIT_EXTENSION

SAVE_SCHEMA_ACTION_EXTENSION

INFLIGHT_SAVE_SCHEMA_ACTION_EXTENSION

REQUESTED_SAVE_SCHEMA_ACTION_EXTENSION

REQUESTED_LOG_COMPACTION_SUFFIX

REQUESTED_LOG_COMPACTION_EXTENSION

INFLIGHT_LOG_COMPACTION_EXTENSION

INVALID_INSTANT_TS

INIT_INSTANT_TS

METADATA_BOOTSTRAP_INSTANT_TS

FULL_BOOTSTRAP_INSTANT_TS

EQUALS

GREATER_THAN_OR_EQUALS

GREATER_THAN

LESSER_THAN_OR_EQUALS

LESSER_THAN

Method Detail

filterInflights

filterInflightsAndRequested

filterPendingExcludingCompaction

filterPendingExcludingLogCompaction

filterPendingExcludingMajorAndMinorCompaction

filterCompletedInstants

filterCompletedAndCompactionInstants

filterCompletedOrMajorOrMinorCompactionInstants

filterCompletedInstantsOrRewriteTimeline

getWriteTimeline

getContiguousCompletedWriteTimeline

getCompletedReplaceTimeline

filterPendingCompactionTimeline

filterPendingLogCompactionTimeline

filterPendingMajorOrMinorCompactionTimeline

filterPendingReplaceTimeline

filterPendingRollbackTimeline

filterRequestedRollbackTimeline