Packagecom.amazonaws.services.sqs.model
Classpublic class DeleteMessageRequest
InheritanceDeleteMessageRequest Inheritance AmazonWebServiceRequest Inheritance Object

Language Version : ActionScript 3.0
Product Version : Flex 4
Since : February 3. 2011
Runtime Versions : Flash Player 10.1, AIR 2.5

Container for the parameters to the DeleteMessage operation. The DeleteMessage action unconditionally removes the specified message from the specified queue. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue.



Public Methods
 MethodDefined By
  
DeleteMessageRequest(queueUrl:String = null, receiptHandle:String = null)
Constructs a new DeleteMessageRequest object.
DeleteMessageRequest
  
getQueueUrl():String
The queue URL.
DeleteMessageRequest
  
The receipt handle associated with the message to delete.
DeleteMessageRequest
  
setQueueUrl(queueUrl:String):void
Expected queue URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).
DeleteMessageRequest
  
setReceiptHandle(receiptHandle:String):void
The receipt handle associated with the message to delete.
DeleteMessageRequest
  
toString():String
Returns a string representation of this object; useful for testing and debugging.
DeleteMessageRequest
  
Expected query URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).
DeleteMessageRequest
  
The receipt handle associated with the message to delete.
DeleteMessageRequest
Constructor Detail
DeleteMessageRequest()Constructor
public function DeleteMessageRequest(queueUrl:String = null, receiptHandle:String = null)

Constructs a new DeleteMessageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters
queueUrl:String (default = null) — queue URL (http|https://endpoint/12digitOwnerAccountId/QueueName)
 
receiptHandle:String (default = null) — The receipt handle associated with the message to delete.
Method Detail
getQueueUrl()method
public function getQueueUrl():String

The queue URL. (http|https://endpoint/12digitOwnerAccountId/QueueName).

Returns
String — queue URL
getReceiptHandle()method 
public function getReceiptHandle():String

The receipt handle associated with the message to delete.

Returns
String — The receipt handle associated with the message to delete.
setQueueUrl()method 
public function setQueueUrl(queueUrl:String):void

Expected queue URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).

Parameters

queueUrl:String — queue URL

setReceiptHandle()method 
public function setReceiptHandle(receiptHandle:String):void

The receipt handle associated with the message to delete.

Parameters

receiptHandle:String — The receipt handle associated with the message to delete.

toString()method 
public function toString():String

Returns a string representation of this object; useful for testing and debugging.

Returns
String — A string representation of this object.
withQueueUrl()method 
public function withQueueUrl(queueUrl:String):DeleteMessageRequest

Expected query URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).

Parameters

queueUrl:String — queue URL

Returns
DeleteMessageRequest — A reference to this updated object so that method calls can be chained together.
withReceiptHandle()method 
public function withReceiptHandle(receiptHandle:String):DeleteMessageRequest

The receipt handle associated with the message to delete.

Parameters

receiptHandle:String — The receipt handle associated with the message to delete.

Returns
DeleteMessageRequest — A reference to this updated object so that method calls can be chained together.