Package com.pushtechnology.diffusion.client.features

Interface TimeSeries.EventMetadata

All Known Subinterfaces:
TimeSeries.Event<V>
Enclosing interface:
TimeSeries
public static interface TimeSeries.EventMetadata
Time series event metadata.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    author()
    Server-authenticated identity of the session that created the event.
    long
    sequence()
    Sequence number identifying this event within its time series.
    long
    timestamp()
    Event timestamp.

  • Method Details

    • sequence

      long sequence()
      Sequence number identifying this event within its time series. Assigned by the server when the event is created.

      Sequence numbers are unique within a time series. Each event appended to a time series is assigned a sequence number that is is equal to the sequence number of the preceding event plus one.

      Returns:
      sequence number; non-negative

    • timestamp

      long timestamp()
      Event timestamp. Assigned by the server when the event is created.

      Events do not have unique timestamps. Events with different sequence numbers may have the same timestamp.

      Subsequent events in a time series usually have timestamps that are greater or equal to the timestamps of earlier events, but this is not guaranteed due to changes to the time source used by the server.

      Returns:
      the difference, measured in milliseconds, between the time the server added the event to the time series and midnight, January 1, 1970 UTC

    • author

      String author()
      Server-authenticated identity of the session that created the event.
      Returns:
      the principal that created the event, or Session.ANONYMOUS if the session that created the event was not authenticated