Package org.apache.storm.topology

# Class TupleFieldTimestampExtractor

java.lang.Object
org.apache.storm.topology.TupleFieldTimestampExtractor

All Implemented Interfaces:
  `Serializable`, `TimestampExtractor`

public final class TupleFieldTimestampExtractor extends Object implements TimestampExtractor
A `TimestampExtractor` that extracts timestamp from a specific field in the tuple.

See Also:
  - Serialized Form

- ## Method Summary

  Modifier and Type
  Method
  Description
  `long`
  `extractTimestamp(Tuple tuple)`
  Return the tuple timestamp indicating the time when the event happened.
  `static TupleFieldTimestampExtractor`
  `of(String fieldName)`
  `String`
  `toString()`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Method Details

  - ### of

    public static TupleFieldTimestampExtractor of(String fieldName)

  - ### extractTimestamp

    public long extractTimestamp(Tuple tuple)
    Description copied from interface: `TimestampExtractor`
    Return the tuple timestamp indicating the time when the event happened.
    Specified by:
      `extractTimestamp` in interface `TimestampExtractor`
    Parameters:
      `tuple` - the tuple
    Returns:
      the timestamp

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Object`