org.jclouds.sqs.options

Class ReceiveMessageOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.sqs.options.ReceiveMessageOptions

All Implemented Interfaces:

Cloneable, HttpRequestOptions

public class ReceiveMessageOptions
extends BaseHttpRequestOptions
implements Cloneable

Options used to receive a message from a queue.

Author:

Adrian Cole

See Also:

docs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReceiveMessageOptions.Builder

Field Summary

Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor and Description
ReceiveMessageOptions()

Method Summary

Methods

Modifier and Type	Method and Description
ReceiveMessageOptions	attribute(String attribute)
ReceiveMessageOptions	attributes(Iterable<String> attributes) The attribute you want to get.
com.google.common.collect.Multimap<String,String>	buildFormParameters() Builds form parameters representing options.
ReceiveMessageOptions	clone()
boolean	equals(Object obj)
int	hashCode()
String	toString()
ReceiveMessageOptions	visibilityTimeout(Integer visibilityTimeout) The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

Methods inherited from class org.jclouds.http.options.BaseHttpRequestOptions

buildPathSuffix, buildQueryParameters, buildRequestHeaders, buildStringPayload, getFirstFormOrNull, getFirstHeaderOrNull, getFirstQueryOrNull, replaceHeader

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReceiveMessageOptions

public ReceiveMessageOptions()

Method Detail

visibilityTimeout

public ReceiveMessageOptions visibilityTimeout(Integer visibilityTimeout)

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

Parameters:

visibilityTimeout - Constraints: 0 to 43200 (maximum 12 hours) Default: The visibility timeout for the queue

attributes

public ReceiveMessageOptions attributes(Iterable<String> attributes)

The attribute you want to get. All - returns all values. SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender. SentTimestamp - returns the time when the message was sent (epoch time in milliseconds). ApproximateReceiveCount - returns the number of times a message has been received but not deleted. ApproximateFirstReceiveTimestamp - returns the time when the message was first received (epoch time in milliseconds).

attribute

public ReceiveMessageOptions attribute(String attribute)

See Also:

attributes

buildFormParameters

public com.google.common.collect.Multimap<String,String> buildFormParameters()

Description copied from interface: HttpRequestOptions

Builds form parameters representing options.

Specified by:

buildFormParameters in interface HttpRequestOptions

Overrides:

buildFormParameters in class BaseHttpRequestOptions

Returns:

map that may contain query parameters.

hashCode

public int hashCode()

Overrides:

hashCode in class BaseHttpRequestOptions

clone

public ReceiveMessageOptions clone()

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class BaseHttpRequestOptions

toString

public String toString()

Overrides:

toString in class BaseHttpRequestOptions