SendMessageResult Class

Package:

com.azure.storage.queue.models

Maven Artifact:

com.azure:azure-storage-queue:12.23.0

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

Implements

XmlSerializable<SendMessageResult>

public final class SendMessageResult
implements XmlSerializable<SendMessageResult>

The object returned in the QueueMessageList array when calling Put Message on a Queue.

Constructor Summary

Constructor	Description
SendMessageResult()	Creates an instance of SendMessageResult class.

Method Summary

Modifier and Type	Method and Description
static SendMessageResult	fromXml(XmlReader xmlReader) Reads an instance of SendMessageResult from the XmlReader.
static SendMessageResult	fromXml(XmlReader xmlReader, String rootElementName) Reads an instance of SendMessageResult from the XmlReader.
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	getPopReceipt() Get the popReceipt property: This value is required to delete the Message.
OffsetDateTime	getTimeNextVisible() Get the timeNextVisible property: The time that the message will again become visible in the Queue.
SendMessageResult	setExpirationTime(OffsetDateTime expirationTime) Set the expirationTime property: The time that the Message will expire and be automatically deleted.
SendMessageResult	setInsertionTime(OffsetDateTime insertionTime) Set the insertionTime property: The time the Message was inserted into the Queue.
SendMessageResult	setMessageId(String messageId) Set the messageId property: The Id of the Message.
SendMessageResult	setPopReceipt(String popReceipt) Set the popReceipt property: This value is required to delete the Message.
SendMessageResult	setTimeNextVisible(OffsetDateTime timeNextVisible) Set the timeNextVisible property: The time that the message will again become visible in the Queue.
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

SendMessageResult

public SendMessageResult()

Creates an instance of SendMessageResult class.

Method Details

fromXml

public static SendMessageResult fromXml(XmlReader xmlReader)

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 the deserialized XML object was missing any required properties.

fromXml

public static SendMessageResult fromXml(XmlReader xmlReader, String rootElementName)

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 the deserialized XML object was missing any required properties.

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.

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.

getTimeNextVisible

public OffsetDateTime getTimeNextVisible()

Get the timeNextVisible property: The time that the message will again become visible in the Queue.

Returns:

the timeNextVisible 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.

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.

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.

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.

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 XmlWriter toXml(XmlWriter xmlWriter)

Parameters:

xmlWriter

Throws:

XMLStreamException

toXml

public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Parameters:

xmlWriter

rootElementName

Throws:

XMLStreamException