io.numaproj.numaflow.sourcetransformer.Datum Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of numaflow-java Show documentation

SDK to implement Numaflow Source or User Defined Functions or Sinks in Java.

The newest version!

package io.numaproj.numaflow.sourcetransformer;


import java.time.Instant;
import java.util.Map;

/**
 * Datum contains methods to get the payload information.
 */

public interface Datum {
    /**
     * method to get the payload value
     *
     * @return returns the payload value in byte array
     */
    byte[] getValue();

    /**
     * method to get the event time of the payload
     *
     * @return returns the event time of the payload
     */
    Instant getEventTime();

    /**
     * method to get the watermark information
     *
     * @return returns the watermark
     */
    Instant getWatermark();

    /**
     * method to get the headers information of the payload
     *
     * @return returns the headers in the form of key value pair
     */
    Map getHeaders();
}