KubeMQ.QueueSendResult (kubemq v1.0.1)

Copy Markdown View Source

Result of sending a queue message.

Returned from KubeMQ.Client.send_queue_message/2.

Fields

  • message_id (String.t()) — ID of the sent message.
  • sent_at (integer()) — Unix timestamp when the message was accepted by the server.
  • expiration_at (integer()) — Unix timestamp when the message will expire (0 if no expiration).
  • delayed_to (integer()) — Unix timestamp when the message will become available (0 if no delay).
  • is_error (boolean()) — Whether sending failed.
  • error (String.t() | nil) — Error message if is_error is true.

Summary

Types

t()

@type t() :: %KubeMQ.QueueSendResult{
  delayed_to: integer(),
  error: String.t() | nil,
  expiration_at: integer(),
  is_error: boolean(),
  message_id: String.t(),
  sent_at: integer()
}

Functions

from_transport(result)

@spec from_transport(map()) :: t()

new(opts \\ [])

@spec new(keyword()) :: t()