com.azure.storage.queue.models

Class PeekedMessageItem

java.lang.Object

com.azure.storage.queue.models.PeekedMessageItem

public final class PeekedMessageItem
extends Object

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

Constructor Summary

Constructors

Constructor and Description
PeekedMessageItem()

Method Summary

Modifier and Type	Method and Description
com.azure.core.util.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 PeekedMessageItem.getBody() instead.
PeekedMessageItem	setBody(com.azure.core.util.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 PeekedMessageItem.setBody(BinaryData) instead.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeekedMessageItem

public PeekedMessageItem()

Method Detail

getMessageId

public String getMessageId()

Get the messageId property: The Id of the Message.

Returns:

the messageId value.

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.

getInsertionTime

public OffsetDateTime getInsertionTime()

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

Returns:

the insertionTime value.

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.

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

getDequeueCount

public long getDequeueCount()

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

Returns:

the dequeueCount value.

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.

getMessageText

@Deprecated
public String getMessageText()

Deprecated. use PeekedMessageItem.getBody() instead.

Get the messageText property: The content of the Message.

Returns:

the messageText value.

setMessageText

@Deprecated
public PeekedMessageItem setMessageText(String messageText)

Deprecated. use PeekedMessageItem.setBody(BinaryData) instead.

Set the messageText property: The content of the Message.

Parameters:

messageText - the messageText value to set.

Returns:

the PeekedMessageItem object itself.

getBody

public com.azure.core.util.BinaryData getBody()

Get the body property: The content of the Message.

Returns:

the body value.

setBody

public PeekedMessageItem setBody(com.azure.core.util.BinaryData body)

Set the body property: The content of the Message.

Parameters:

body - the body value to set.

Returns:

the PeekedMessageItem object itself.