PeekedMessageItem Class

Package:

com.azure.storage.queue.models

Maven Artifact:

com.azure:azure-storage-queue:12.24.0

• java.lang.Object
• • com.azure.storage.queue.models.PeekedMessageItem

Implements

XmlSerializable<PeekedMessageItem>

public final class PeekedMessageItem
implements XmlSerializable<PeekedMessageItem>

The object returned in the QueueMessageList array when calling Peek Messages on a Queue.

Constructor Summary

Constructor	Description
PeekedMessageItem()	Creates an instance of PeekedMessageItem.

Method Summary

Modifier and Type	Method and Description
static PeekedMessageItem	fromXml(XmlReader xmlReader) Reads an instance of PeekedMessageItem from the XmlReader.
static PeekedMessageItem	fromXml(XmlReader xmlReader, String rootElementName) Reads an instance of PeekedMessageItem from the XmlReader.
BinaryData	getBody() Get the body property: The content of the Message.
long	getDequeueCount() Get the dequeueCount property: The number of times the message has been dequeued.
OffsetDateTime	getExpirationTime() Get the expirationTime property: The time that the Message will expire and be automatically deleted.
OffsetDateTime	getInsertionTime() Get the insertionTime property: The time the Message was inserted into the Queue.
String	getMessageId() Get the messageId property: The Id of the Message.
String	getMessageText() Deprecated use getBody() instead. Get the messageText property: The content of the Message.
PeekedMessageItem	setBody(BinaryData body) Set the body property: The content of the Message.
PeekedMessageItem	setDequeueCount(long dequeueCount) Set the dequeueCount property: The number of times the message has been dequeued.
PeekedMessageItem	setExpirationTime(OffsetDateTime expirationTime) Set the expirationTime property: The time that the Message will expire and be automatically deleted.
PeekedMessageItem	setInsertionTime(OffsetDateTime insertionTime) Set the insertionTime property: The time the Message was inserted into the Queue.
PeekedMessageItem	setMessageId(String messageId) Set the messageId property: The Id of the Message.
PeekedMessageItem	setMessageText(String messageText) Deprecated use setBody(BinaryData body) instead. Set the messageText property: The content of the Message.
XmlWriter	toXml(XmlWriter xmlWriter)
XmlWriter	toXml(XmlWriter xmlWriter, String rootElementName)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PeekedMessageItem

public PeekedMessageItem()

Creates an instance of PeekedMessageItem.

Method Details

fromXml

public static PeekedMessageItem fromXml(XmlReader xmlReader)

Reads an instance of PeekedMessageItem from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

Returns:

An instance of PeekedMessageItem if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

- If the deserialized XML object was missing any required properties.

fromXml

public static PeekedMessageItem fromXml(XmlReader xmlReader, String rootElementName)

Reads an instance of PeekedMessageItem 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 PeekedMessageItem if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

- If the deserialized XML object was missing any required properties.

getBody

public BinaryData getBody()

Get the body property: The content of the Message.

Returns:

the body value.

getDequeueCount

public long getDequeueCount()

Get the dequeueCount property: The number of times the message has been dequeued.

Returns:

the dequeueCount value.

getExpirationTime

public OffsetDateTime getExpirationTime()

Get the expirationTime property: The time that the Message will expire and be automatically deleted.

Returns:

the expirationTime value.

getInsertionTime

public OffsetDateTime getInsertionTime()

Get the insertionTime property: The time the Message was inserted into the Queue.

Returns:

the insertionTime value.

getMessageId

public String getMessageId()

Get the messageId property: The Id of the Message.

Returns:

the messageId value.

getMessageText

@Deprecated
public String getMessageText()

Deprecated

use getBody() instead.

Get the messageText property: The content of the Message.

Returns:

the messageText value.

setBody

public PeekedMessageItem setBody(BinaryData body)

Set the body property: The content of the Message.

Parameters:

body - the body value to set.

Returns:

the PeekedMessageItem object itself.

setDequeueCount

public PeekedMessageItem 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 PeekedMessageItem object itself.

setExpirationTime

public PeekedMessageItem 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 PeekedMessageItem object itself.

setInsertionTime

public PeekedMessageItem 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 PeekedMessageItem object itself.

setMessageId

public PeekedMessageItem setMessageId(String messageId)

Set the messageId property: The Id of the Message.

Parameters:

messageId - the messageId value to set.

Returns:

the PeekedMessageItem object itself.

setMessageText

@Deprecated
public PeekedMessageItem setMessageText(String messageText)

Deprecated

use setBody(BinaryData body) instead.

Set the messageText property: The content of the Message.

Parameters:

messageText - the messageText value to set.

Returns:

the PeekedMessageItem object itself.

toXml

public XmlWriter toXml(XmlWriter xmlWriter)

Parameters:

xmlWriter

Throws:

XMLStreamException

toXml

public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Parameters:

xmlWriter

rootElementName

Throws:

XMLStreamException