io.numaproj.numaflow.sideinput.Message 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.sideinput;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;

/**
 * Message is used to wrap the data returned by Side Input Retriever.
 */

@Getter
@AllArgsConstructor(access = AccessLevel.PRIVATE)
public class Message {
    private final byte[] value;
    private final boolean noBroadcast;

    /**
     * createBroadcastMessage creates a new Message with the given value
     * This is used to broadcast the message to other side input vertices.
     *
     * @param value message value
     *
     * @return returns the Message with noBroadcast flag set to false
     */
    public static Message createBroadcastMessage(byte[] value) {
        return new Message(value, false);
    }

    /**
     * createNoBroadcastMessage creates a new Message with noBroadcast flag set to true
     * This is used to drop the message and not to broadcast it to other side input vertices.
     *
     * @return returns the Message with noBroadcast flag set to true
     */
    public static Message createNoBroadcastMessage() {
        return new Message(new byte[0], true);
    }
}