Class Solace.PublishResult

java.lang.Object
org.apache.beam.sdk.io.solace.data.Solace.PublishResult
Enclosing class:
Solace

@DefaultSchema(AutoValueSchema.class) public abstract static class Solace.PublishResult extends Object
The result of writing a message to Solace. This will be returned by the SolaceIO.Write connector.

This class provides a builder to create instances, but you will probably not need it. The write connector will create and return instances of Solace.PublishResult.

If the message has been published, getPublished() will be true. If it is false, it means that the message could not be published, and getError() will contain more details about why the message could not be published.

  • Constructor Details

    • PublishResult

      public PublishResult()
  • Method Details

    • getMessageId

      @SchemaFieldNumber("0") public abstract String getMessageId()
      The message id of the message that was published.
    • getPublished

      @SchemaFieldNumber("1") public abstract boolean getPublished()
      Whether the message was published or not.
    • getLatencyNanos

      @SchemaFieldNumber("2") public abstract @Nullable Long getLatencyNanos()
      The publishing latency in nanoseconds. This is the difference between the time the message was created, and the time the message was published. It is only available if the Solace.CorrelationKey class is used as correlation key of the messages, and null otherwise.
    • getError

      @SchemaFieldNumber("3") public abstract @Nullable String getError()
      The error details if the message could not be published.
    • builder

      public static Solace.PublishResult.Builder builder()