Package com.azure.storage.queue.models

Class SendMessageResult

java.lang.Object
com.azure.storage.queue.models.SendMessageResult
All Implemented Interfaces:
com.azure.xml.XmlSerializable<SendMessageResult>
public final class SendMessageResult extends Object implements com.azure.xml.XmlSerializable<SendMessageResult>
The object returned in the QueueMessageList array when calling Put Message on a Queue.

  • Constructor Details

    • SendMessageResult

      public SendMessageResult()
      Creates an instance of SendMessageResult class.

  • Method Details

    • getMessageId

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

    • setMessageId

      public SendMessageResult setMessageId(String messageId)
      Set the messageId property: The Id of the Message.
      Parameters:
      messageId - the messageId value to set.
      Returns:
      the SendMessageResult 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 SendMessageResult 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 SendMessageResult 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 SendMessageResult 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 SendMessageResult 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 SendMessageResult 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 SendMessageResult 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 SendMessageResult 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 SendMessageResult object itself.

    • toXml

      public com.azure.xml.XmlWriter toXml(com.azure.xml.XmlWriter xmlWriter) throws XMLStreamException
      Specified by:
      toXml in interface com.azure.xml.XmlSerializable<SendMessageResult>
      Throws:
      XMLStreamException

    • toXml

      public com.azure.xml.XmlWriter toXml(com.azure.xml.XmlWriter xmlWriter, String rootElementName) throws XMLStreamException
      Specified by:
      toXml in interface com.azure.xml.XmlSerializable<SendMessageResult>
      Throws:
      XMLStreamException

    • fromXml

      public static SendMessageResult fromXml(com.azure.xml.XmlReader xmlReader) throws XMLStreamException
      Reads an instance of SendMessageResult from the XmlReader.
      Parameters:
      xmlReader - The XmlReader being read.
      Returns:
      An instance of SendMessageResult if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.
      Throws:
      XMLStreamException - If an error occurs while reading the SendMessageResult.

    • fromXml

      public static SendMessageResult fromXml(com.azure.xml.XmlReader xmlReader, String rootElementName) throws XMLStreamException
      Reads an instance of SendMessageResult from the XmlReader.
      Parameters:
      xmlReader - The XmlReader being read.
      rootElementName - Optional root element name to override the default defined by the model. Used to support cases where the model can deserialize from different root element names.
      Returns:
      An instance of SendMessageResult if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.
      Throws:
      XMLStreamException - If an error occurs while reading the SendMessageResult.