Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejava
firstline1
titleVersionedKeyValueStore.java
linenumberstrue
package org.apache.kafka.streams.state;
     /**
     * Get the record associated with this key as of the specified timestamp (i.e.,
     * the existing record with the largest timestamp not exceeding the provided
     * timestamp bound).
     *
     * @param key           The key to fetch
     * @param fromTimestamp 
     * @param asOfTimestamp The timestamp lower bound. ThisThe boundrecords isthat inclusive;have ifbeen a record
     *                      (for the specified key) exists with this timestamp, then
     *                      this is the record that will beinserted at 
							or before this timestamp and did not become tombstone at or before 
							this timestamp will be retrieved and returned.
     * @param *asOfTimestamp @return The value and timestamp of the record associated with this key
     *  bound. This bound is inclusive; if a record
     *  as of the provided timestamp, or {@code null} if no such record exists
     *    (for the specified key) exists (includingwith ifthis thetimestamp, providedthen
 timestamp bound is older than* this store's  history
     *         retention time, i.e., the storethis nois longerthe containsrecord datathat forwill thebe providedreturned.
     * @return The value and timestamp (along with the validTo timestamp). Noteof that the record timestamp {@code r.timestamp()} of theassociated with this key
     *         as  returnedof the provided timestamp, or {@link@code VersionedRecordnull} mayif beno smallersuch than the provided timestamprecord exists
     *         bound. Additionally, (including if the latestprovided timestamp recordbound versionis forolder thethan keythis isstore's eligiblehistory
     *         forretention the provided timestamp bound, then that record will be returned even iftime, i.e., the store no longer contains data for the provided
     *         the timestamp bound is older than the store's history retention.). 
     * @throws NullPointerException       If null is used for key.
     * @throws InvalidStateStoreException if the store is not initialized
     */
    VersionedRecord<V> get(K key, long fromTimestamp, long asOfTimestamp);

...