Class QueueMessageItem

java.lang.Object
com.azure.storage.queue.models.QueueMessageItem

public final class QueueMessageItem extends Object
The object returned in the QueueMessageList array when calling Get Messages on a Queue.
  • Constructor Details

    • QueueMessageItem

      public QueueMessageItem()
  • Method Details

    • getMessageId

      public String getMessageId()
      Get the messageId property: The Id of the Message.
      Returns:
      the messageId value.
    • setMessageId

      public QueueMessageItem setMessageId(String messageId)
      Set the messageId property: The Id of the Message.
      Parameters:
      messageId - the messageId value to set.
      Returns:
      the QueueMessageItem object itself.
    • getInsertionTime

      public OffsetDateTime getInsertionTime()
      Get the insertionTime property: The time the Message was inserted into the Queue.
      Returns:
      the insertionTime value.
    • setInsertionTime

      public QueueMessageItem setInsertionTime(OffsetDateTime insertionTime)
      Set the insertionTime property: The time the Message was inserted into the Queue.
      Parameters:
      insertionTime - the insertionTime value to set.
      Returns:
      the QueueMessageItem object itself.
    • getExpirationTime

      public OffsetDateTime getExpirationTime()
      Get the expirationTime property: The time that the Message will expire and be automatically deleted.
      Returns:
      the expirationTime value.
    • setExpirationTime

      public QueueMessageItem setExpirationTime(OffsetDateTime expirationTime)
      Set the expirationTime property: The time that the Message will expire and be automatically deleted.
      Parameters:
      expirationTime - the expirationTime value to set.
      Returns:
      the QueueMessageItem object itself.
    • getPopReceipt

      public String getPopReceipt()
      Get the popReceipt property: This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client.
      Returns:
      the popReceipt value.
    • setPopReceipt

      public QueueMessageItem setPopReceipt(String popReceipt)
      Set the popReceipt property: This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client.
      Parameters:
      popReceipt - the popReceipt value to set.
      Returns:
      the QueueMessageItem object itself.
    • getTimeNextVisible

      public OffsetDateTime getTimeNextVisible()
      Get the timeNextVisible property: The time that the message will again become visible in the Queue.
      Returns:
      the timeNextVisible value.
    • setTimeNextVisible

      public QueueMessageItem setTimeNextVisible(OffsetDateTime timeNextVisible)
      Set the timeNextVisible property: The time that the message will again become visible in the Queue.
      Parameters:
      timeNextVisible - the timeNextVisible value to set.
      Returns:
      the QueueMessageItem object itself.
    • getDequeueCount

      public long getDequeueCount()
      Get the dequeueCount property: The number of times the message has been dequeued.
      Returns:
      the dequeueCount value.
    • setDequeueCount

      public QueueMessageItem setDequeueCount(long dequeueCount)
      Set the dequeueCount property: The number of times the message has been dequeued.
      Parameters:
      dequeueCount - the dequeueCount value to set.
      Returns:
      the QueueMessageItem object itself.
    • getMessageText

      @Deprecated public String getMessageText()
      Deprecated.
      use getBody() instead.
      Get the messageText property: The content of the Message.
      Returns:
      the messageText value.
    • setMessageText

      @Deprecated public QueueMessageItem setMessageText(String messageText)
      Deprecated.
      use setBody(BinaryData) instead.
      Set the messageText property: The content of the Message.
      Parameters:
      messageText - the messageText value to set.
      Returns:
      the QueueMessageItem object itself.
    • getBody

      public BinaryData getBody()
      Get the body property: The content of the Message.
      Returns:
      the body value.
    • setBody

      public QueueMessageItem setBody(BinaryData body)
      Set the body property: The content of the Message.
      Parameters:
      body - the body value to set.
      Returns:
      the QueueMessageItem object itself.