Package io.fluxcapacitor.common.api.publishing

Class Append

java.lang.Object
io.fluxcapacitor.common.api.Request
io.fluxcapacitor.common.api.Command
io.fluxcapacitor.common.api.publishing.Append
All Implemented Interfaces:
JsonType
public class Append extends Command
Command to publish messages to a specific log in Flux (e.g., commands, events, metrics, etc.).

The messages are written to the log associated with the given messageType. Each message is represented as a SerializedMessage and is appended to the log in the order provided.

This operation is typically used by low-level clients (such as GatewayClient) that need full control over message serialization and targeting. High-level APIs usually delegate to this command internally.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Append.Metric
    Metric payload used for internal monitoring and logging.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Append()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Guarantee
    getGuarantee()
    Indicates the delivery guarantee required for this command.
    int
    getSize()
     
    String
    routingKey()
    Optionally specifies a routing key for this command, which may be used to partition work or apply consistent hashing when processed in the Flux platform.
    Append.Metric
    toMetric()
    Converts this object into a compact metric representation for logging or monitoring.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Append

      public Append()

  • Method Details

    • getSize

      public int getSize()

    • getGuarantee

      public Guarantee getGuarantee()
      Description copied from class: Command
      Indicates the delivery guarantee required for this command.
      Specified by:
      getGuarantee in class Command
      Returns:
      the Guarantee level (e.g. STORED, SENT, NONE)

    • routingKey

      public String routingKey()
      Description copied from class: Command
      Optionally specifies a routing key for this command, which may be used to partition work or apply consistent hashing when processed in the Flux platform.
      Overrides:
      routingKey in class Command
      Returns:
      a routing key string, or null if not specified

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toMetric

      public Append.Metric toMetric()
      Description copied from interface: JsonType
      Converts this object into a compact metric representation for logging or monitoring.

      Used by the Flux client to avoid logging large payloads directly while still tracking platform usage.

      Returns:
      a safe and compact object suitable for serialization to the metrics log