com.azure.storage.queue.models.QueueMessageItem.yml

### YamlMime:JavaType
uid: "com.azure.storage.queue.models.QueueMessageItem"
fullName: "com.azure.storage.queue.models.QueueMessageItem"
name: "QueueMessageItem"
nameWithType: "QueueMessageItem"
summary: "The object returned in the Queue<wbr>Message<wbr>List array when calling Get Messages on a Queue."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **QueueMessageItem**</br> implements <xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.storage.queue.models.QueueMessageItem.QueueMessageItem()"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.QueueMessageItem()"
  name: "QueueMessageItem()"
  nameWithType: "QueueMessageItem.QueueMessageItem()"
  summary: "Creates an instance of Queue<wbr>Message<wbr>Item."
  syntax: "public QueueMessageItem()"
  desc: "Creates an instance of QueueMessageItem."
methods:
- uid: "com.azure.storage.queue.models.QueueMessageItem.fromXml(com.azure.xml.XmlReader)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.fromXml(XmlReader xmlReader)"
  name: "fromXml(XmlReader xmlReader)"
  nameWithType: "QueueMessageItem.fromXml(XmlReader xmlReader)"
  summary: "Reads an instance of Queue<wbr>Message<wbr>Item from the Xml<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The XmlReader being read."
    name: "xmlReader"
    type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static QueueMessageItem fromXml(XmlReader xmlReader)"
  exceptions:
  - description: "If the deserialized XML object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
  desc: "Reads an instance of QueueMessageItem from the XmlReader."
  returns:
    description: "An instance of QueueMessageItem if the XmlReader was pointing to an instance of it, or null if it\n was pointing to XML null."
    type: "<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.fromXml(com.azure.xml.XmlReader,java.lang.String)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.fromXml(XmlReader xmlReader, String rootElementName)"
  name: "fromXml(XmlReader xmlReader, String rootElementName)"
  nameWithType: "QueueMessageItem.fromXml(XmlReader xmlReader, String rootElementName)"
  summary: "Reads an instance of Queue<wbr>Message<wbr>Item from the Xml<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The XmlReader being read."
    name: "xmlReader"
    type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
  - description: "Optional root element name to override the default defined by the model. Used to support\n cases where the model can deserialize from different root element names."
    name: "rootElementName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public static QueueMessageItem fromXml(XmlReader xmlReader, String rootElementName)"
  exceptions:
  - description: "If the deserialized XML object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
  desc: "Reads an instance of QueueMessageItem from the XmlReader."
  returns:
    description: "An instance of QueueMessageItem if the XmlReader was pointing to an instance of it, or null if it\n was pointing to XML null."
    type: "<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.getBody()"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.getBody()"
  name: "getBody()"
  nameWithType: "QueueMessageItem.getBody()"
  summary: "Get the body property: The content of the Message."
  syntax: "public BinaryData getBody()"
  desc: "Get the body property: The content of the Message."
  returns:
    description: "the body value."
    type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.getDequeueCount()"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.getDequeueCount()"
  name: "getDequeueCount()"
  nameWithType: "QueueMessageItem.getDequeueCount()"
  summary: "Get the dequeue<wbr>Count property: The number of times the message has been dequeued."
  syntax: "public long getDequeueCount()"
  desc: "Get the dequeueCount property: The number of times the message has been dequeued."
  returns:
    description: "the dequeueCount value."
    type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.getExpirationTime()"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.getExpirationTime()"
  name: "getExpirationTime()"
  nameWithType: "QueueMessageItem.getExpirationTime()"
  summary: "Get the expiration<wbr>Time property: The time that the Message will expire and be automatically deleted."
  syntax: "public OffsetDateTime getExpirationTime()"
  desc: "Get the expirationTime property: The time that the Message will expire and be automatically deleted."
  returns:
    description: "the expirationTime value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.queue.models.QueueMessageItem.getInsertionTime()"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.getInsertionTime()"
  name: "getInsertionTime()"
  nameWithType: "QueueMessageItem.getInsertionTime()"
  summary: "Get the insertion<wbr>Time property: The time the Message was inserted into the Queue."
  syntax: "public OffsetDateTime getInsertionTime()"
  desc: "Get the insertionTime property: The time the Message was inserted into the Queue."
  returns:
    description: "the insertionTime value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.queue.models.QueueMessageItem.getMessageId()"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.getMessageId()"
  name: "getMessageId()"
  nameWithType: "QueueMessageItem.getMessageId()"
  summary: "Get the message<wbr>Id property: The Id of the Message."
  syntax: "public String getMessageId()"
  desc: "Get the messageId property: The Id of the Message."
  returns:
    description: "the messageId value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.queue.models.QueueMessageItem.getMessageText()"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.getMessageText()"
  name: "getMessageText()"
  nameWithType: "QueueMessageItem.getMessageText()"
  summary: "Get the message<wbr>Text property: The content of the Message."
  deprecatedTag: "use <xref uid=\"com.azure.storage.queue.models.QueueMessageItem.getBody()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getBody()\"></xref> instead."
  syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public String getMessageText()"
  desc: "Get the messageText property: The content of the Message."
  hasDeprecatedTag: true
  returns:
    description: "the messageText value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.queue.models.QueueMessageItem.getPopReceipt()"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.getPopReceipt()"
  name: "getPopReceipt()"
  nameWithType: "QueueMessageItem.getPopReceipt()"
  summary: "Get the pop<wbr>Receipt property: This value is required to delete the Message."
  syntax: "public String getPopReceipt()"
  desc: "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:
    description: "the popReceipt value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.queue.models.QueueMessageItem.getTimeNextVisible()"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.getTimeNextVisible()"
  name: "getTimeNextVisible()"
  nameWithType: "QueueMessageItem.getTimeNextVisible()"
  summary: "Get the time<wbr>Next<wbr>Visible property: The time that the message will again become visible in the Queue."
  syntax: "public OffsetDateTime getTimeNextVisible()"
  desc: "Get the timeNextVisible property: The time that the message will again become visible in the Queue."
  returns:
    description: "the timeNextVisible value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.queue.models.QueueMessageItem.setBody(com.azure.core.util.BinaryData)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.setBody(BinaryData body)"
  name: "setBody(BinaryData body)"
  nameWithType: "QueueMessageItem.setBody(BinaryData body)"
  summary: "Set the body property: The content of the Message."
  parameters:
  - description: "the body value to set."
    name: "body"
    type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public QueueMessageItem setBody(BinaryData body)"
  desc: "Set the body property: The content of the Message."
  returns:
    description: "the QueueMessageItem object itself."
    type: "<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.setDequeueCount(long)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.setDequeueCount(long dequeueCount)"
  name: "setDequeueCount(long dequeueCount)"
  nameWithType: "QueueMessageItem.setDequeueCount(long dequeueCount)"
  summary: "Set the dequeue<wbr>Count property: The number of times the message has been dequeued."
  parameters:
  - description: "the dequeueCount value to set."
    name: "dequeueCount"
    type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public QueueMessageItem setDequeueCount(long dequeueCount)"
  desc: "Set the dequeueCount property: The number of times the message has been dequeued."
  returns:
    description: "the QueueMessageItem object itself."
    type: "<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.setExpirationTime(java.time.OffsetDateTime)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.setExpirationTime(OffsetDateTime expirationTime)"
  name: "setExpirationTime(OffsetDateTime expirationTime)"
  nameWithType: "QueueMessageItem.setExpirationTime(OffsetDateTime expirationTime)"
  summary: "Set the expiration<wbr>Time property: The time that the Message will expire and be automatically deleted."
  parameters:
  - description: "the expirationTime value to set."
    name: "expirationTime"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
  syntax: "public QueueMessageItem setExpirationTime(OffsetDateTime expirationTime)"
  desc: "Set the expirationTime property: The time that the Message will expire and be automatically deleted."
  returns:
    description: "the QueueMessageItem object itself."
    type: "<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.setInsertionTime(java.time.OffsetDateTime)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.setInsertionTime(OffsetDateTime insertionTime)"
  name: "setInsertionTime(OffsetDateTime insertionTime)"
  nameWithType: "QueueMessageItem.setInsertionTime(OffsetDateTime insertionTime)"
  summary: "Set the insertion<wbr>Time property: The time the Message was inserted into the Queue."
  parameters:
  - description: "the insertionTime value to set."
    name: "insertionTime"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
  syntax: "public QueueMessageItem setInsertionTime(OffsetDateTime insertionTime)"
  desc: "Set the insertionTime property: The time the Message was inserted into the Queue."
  returns:
    description: "the QueueMessageItem object itself."
    type: "<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.setMessageId(java.lang.String)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.setMessageId(String messageId)"
  name: "setMessageId(String messageId)"
  nameWithType: "QueueMessageItem.setMessageId(String messageId)"
  summary: "Set the message<wbr>Id property: The Id of the Message."
  parameters:
  - description: "the messageId value to set."
    name: "messageId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public QueueMessageItem setMessageId(String messageId)"
  desc: "Set the messageId property: The Id of the Message."
  returns:
    description: "the QueueMessageItem object itself."
    type: "<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.setMessageText(java.lang.String)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.setMessageText(String messageText)"
  name: "setMessageText(String messageText)"
  nameWithType: "QueueMessageItem.setMessageText(String messageText)"
  summary: "Set the message<wbr>Text property: The content of the Message."
  deprecatedTag: "use <xref uid=\"com.azure.storage.queue.models.QueueMessageItem.setBody(com.azure.core.util.BinaryData)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setBody(BinaryData)\"></xref> instead."
  parameters:
  - description: "the messageText value to set."
    name: "messageText"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public QueueMessageItem setMessageText(String messageText)"
  desc: "Set the messageText property: The content of the Message."
  hasDeprecatedTag: true
  returns:
    description: "the QueueMessageItem object itself."
    type: "<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.setPopReceipt(java.lang.String)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.setPopReceipt(String popReceipt)"
  name: "setPopReceipt(String popReceipt)"
  nameWithType: "QueueMessageItem.setPopReceipt(String popReceipt)"
  summary: "Set the pop<wbr>Receipt property: This value is required to delete the Message."
  parameters:
  - description: "the popReceipt value to set."
    name: "popReceipt"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public QueueMessageItem setPopReceipt(String popReceipt)"
  desc: "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."
  returns:
    description: "the QueueMessageItem object itself."
    type: "<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.setTimeNextVisible(java.time.OffsetDateTime)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.setTimeNextVisible(OffsetDateTime timeNextVisible)"
  name: "setTimeNextVisible(OffsetDateTime timeNextVisible)"
  nameWithType: "QueueMessageItem.setTimeNextVisible(OffsetDateTime timeNextVisible)"
  summary: "Set the time<wbr>Next<wbr>Visible property: The time that the message will again become visible in the Queue."
  parameters:
  - description: "the timeNextVisible value to set."
    name: "timeNextVisible"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
  syntax: "public QueueMessageItem setTimeNextVisible(OffsetDateTime timeNextVisible)"
  desc: "Set the timeNextVisible property: The time that the message will again become visible in the Queue."
  returns:
    description: "the QueueMessageItem object itself."
    type: "<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.toXml(com.azure.xml.XmlWriter)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.toXml(XmlWriter xmlWriter)"
  name: "toXml(XmlWriter xmlWriter)"
  nameWithType: "QueueMessageItem.toXml(XmlWriter xmlWriter)"
  parameters:
  - name: "xmlWriter"
    type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public XmlWriter toXml(XmlWriter xmlWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
  returns:
    type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.queue.models.QueueMessageItem.toXml(com.azure.xml.XmlWriter,java.lang.String)"
  fullName: "com.azure.storage.queue.models.QueueMessageItem.toXml(XmlWriter xmlWriter, String rootElementName)"
  name: "toXml(XmlWriter xmlWriter, String rootElementName)"
  nameWithType: "QueueMessageItem.toXml(XmlWriter xmlWriter, String rootElementName)"
  parameters:
  - name: "xmlWriter"
    type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
  - name: "rootElementName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
  returns:
    type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The object returned in the QueueMessageList array when calling Get Messages on a Queue."
implements:
- "<xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.queue.models.QueueMessageItem?alt=com.azure.storage.queue.models.QueueMessageItem&text=QueueMessageItem\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.storage.queue.models"
artifact: com.azure:azure-storage-queue:12.21.1