Retrieves one or more messages from the specified queue, including the message body and message ID of each message. Messages returned by this action stay in the queue until you delete them. However, once a message is returned to a ReceiveMessage request, it is not returned on subsequent ReceiveMessage requests for the duration of the VisibilityTimeout. If you do not specify a VisibilityTimeout in the request, the overall visibility timeout for the queue is used for the returned messages.

Namespace: Amazon.SQS.Model
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public class ReceiveMessageRequest
Public Class ReceiveMessageRequest
public ref class ReceiveMessageRequest

Members

            
 All Members  Constructors   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
ReceiveMessageRequest()()()()
Initializes a new instance of the ReceiveMessageRequest class
AttributeName
Gets and sets the AttributeName property. The attribute you want to get. Valid values: All | SenderId | SentTimestamp | ApproximateReceiveCount | ApproximateFirstReceiveTimestamp
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
IsSetAttributeName()()()()
Checks if AttributeName property is set
IsSetMaxNumberOfMessages()()()()
Checks if MaxNumberOfMessages property is set
IsSetQueueUrl()()()()
Checks if QueueUrl property is set
IsSetVisibilityTimeout()()()()
Checks if VisibilityTimeout property is set
MaxNumberOfMessages
Gets and sets the MaxNumberOfMessages property. Maximum number of messages to return. SQS never returns more messages than this value but might return fewer. Not necessarily all the messages in the queue are returned (for more information, see the preceding note about machine sampling). Values can be from 1 to 10. Default is 1.
QueueUrl
Gets and sets the QueueUrl property. The URL associated with the Amazon SQS queue.
ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
VisibilityTimeout
Gets and sets the VisibilityTimeout property. The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
WithAttributeName(array<String>[]()[][])
Sets the AttributeName property
WithMaxNumberOfMessages(Decimal)
Sets the MaxNumberOfMessages property
WithQueueUrl(String)
Sets the QueueUrl property
WithVisibilityTimeout(Decimal)
Sets the VisibilityTimeout property

Inheritance Hierarchy

System..::..Object
  Amazon.SQS.Model..::..ReceiveMessageRequest

See Also