ListMessagesResult.QueueMessage (Microsoft Azure SDK for Media Services 0.9.8 API)

java.lang.Object
- com.microsoft.windowsazure.services.queue.models.ListMessagesResult.QueueMessage

Enclosing class:

ListMessagesResult
```
public static class ListMessagesResult.QueueMessage
extends Object
```
Represents a message in the queue returned by the server. A ListMessagesResult.QueueMessage instance contains a copy of the queue message data in the storage service as of the time the message was requested.

Constructor Summary

Constructors
Constructor and Description

QueueMessage()

Constructors
Constructor and Description
`QueueMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getDequeueCount()` Gets the number of times this queue message has been retrieved with a list messages operation.
`Date`	`getExpirationDate()` Gets the `Date` when this message will expire and be automatically removed from the queue.
`Date`	`getInsertionDate()` Gets the `Date` when this message was added to the queue.
`String`	`getMessageId()` Gets the message ID for the message in the queue.
`String`	`getMessageText()` Gets the `String` containing the content of the queue message.
`String`	`getPopReceipt()` Gets the pop receipt value for the queue message.
`Date`	`getTimeNextVisible()` Gets the `Date` when this message will become visible in the queue.
`void`	`setDequeueCount(int dequeueCount)` Reserved for internal use.
`void`	`setExpirationDate(Date expirationDate)` Reserved for internal use.
`void`	`setInsertionDate(Date insertionDate)` Reserved for internal use.
`void`	`setMessageId(String messageId)` Reserved for internal use.
`void`	`setMessageText(String messageText)` Reserved for internal use.
`void`	`setPopReceipt(String popReceipt)` Reserved for internal use.
`void`	`setTimeNextVisible(Date timeNextVisible)` Reserved for internal use.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueueMessage
```
public QueueMessage()
```
- Method Detail
  - getMessageId
```
public String getMessageId()
```
    Gets the message ID for the message in the queue. The message ID is a value that is opaque to the client that must be used along with the pop receipt to validate an update message or delete message operation.
    
    Returns:
    
    A String containing the message ID.
  - setMessageId
```
public void setMessageId(String messageId)
```
    Reserved for internal use. Sets the value of the message ID for the queue message. This method is invoked by the API as part of the response generation from the Queue Service REST API operation to set the value with the message ID returned by the server.
    
    Parameters:
    
    messageId - A String containing the message ID.
  - getInsertionDate
```
public Date getInsertionDate()
```
    Gets the Date when this message was added to the queue.
    
    Returns:
    
    The Date when this message was added to the queue.
  - setInsertionDate
```
public void setInsertionDate(Date insertionDate)
```
    Reserved for internal use. Sets the value of the insertion time for the queue message. This method is invoked by the API as part of the response generation from the Queue Service REST API operation to set the value with the insertion time returned by the server.
    
    Parameters:
    
    insertionDate - The Date when this message was added to the queue.
  - getExpirationDate
```
public Date getExpirationDate()
```
    Gets the Date when this message will expire and be automatically removed from the queue.
    
    Returns:
    
    The Date when this message will expire.
  - setExpirationDate
```
public void setExpirationDate(Date expirationDate)
```
    Reserved for internal use. Sets the value of the expiration time for the queue message. This method is invoked by the API as part of the response generation from the Queue Service REST API operation to set the value with the expiration time returned by the server.
    
    Parameters:
    
    expirationDate - The Date when this message will expire.
  - getPopReceipt
```
public String getPopReceipt()
```
    Gets the pop receipt value for the queue message. The pop receipt is a value that is opaque to the client that must be used along with the message ID to validate an update message or delete message operation.
    
    Returns:
    
    A String containing the pop receipt value for the queue message.
  - setPopReceipt
```
public void setPopReceipt(String popReceipt)
```
    Reserved for internal use. Sets the value of the pop receipt for the queue message. This method is invoked by the API as part of the response generation from the Queue Service REST API operation to set the value with the pop receipt returned by the server.
    
    Parameters:
    
    popReceipt - A String containing the pop receipt value for the queue message.
  - getTimeNextVisible
```
public Date getTimeNextVisible()
```
    Gets the Date when this message will become visible in the queue.
    
    Returns:
    
    The Date when this message will become visible in the queue.
  - setTimeNextVisible
```
public void setTimeNextVisible(Date timeNextVisible)
```
    Reserved for internal use. Sets the value of the time the message will become visible. This method is invoked by the API as part of the response generation from the Queue Service REST API operation to set the value with the time next visible returned by the server.
    
    Parameters:
    
    timeNextVisible - The Date when this message will become visible in the queue.
  - getDequeueCount
```
public int getDequeueCount()
```
    Gets the number of times this queue message has been retrieved with a list messages operation.
    
    Returns:
    
    The number of times this queue message has been retrieved.
  - setDequeueCount
```
public void setDequeueCount(int dequeueCount)
```
    Reserved for internal use. Sets the value of the dequeue count of the message. This method is invoked by the API as part of the response generation from the Queue Service REST API operation to set the value with the queue message dequeue count returned by the server.
    
    Parameters:
    
    dequeueCount - The number of times this queue message has been retrieved.
  - getMessageText
```
public String getMessageText()
```
    Gets the String containing the content of the queue message.
    
    Returns:
    
    A String containing the content of the queue message.
  - setMessageText
```
public void setMessageText(String messageText)
```
    Reserved for internal use. Sets the String containing the content of the message. This method is invoked by the API as part of the response generation from the Queue Service REST API operation to set the value with the queue message content returned by the server.
    
    Parameters:
    
    messageText - A String containing the content of the message.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class ListMessagesResult.QueueMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueueMessage

Method Detail

getMessageId

setMessageId

getInsertionDate

setInsertionDate

getExpirationDate

setExpirationDate

getPopReceipt

setPopReceipt

getTimeNextVisible

setTimeNextVisible

getDequeueCount

setDequeueCount

getMessageText

setMessageText