com.amazonaws.services.sqs.model.ReceiveMessageRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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.
*/
package com.amazonaws.services.sqs.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.sqs.AmazonSQS#receiveMessage(ReceiveMessageRequest) ReceiveMessage operation}.
*
* Retrieves one or more messages from the specified queue. Long poll
* support is enabled by using the WaitTimeSeconds
* parameter. For more information, see
* Amazon SQS Long Poll
* in the Amazon SQS Developer Guide .
*
*
*
* Short poll is the default behavior where a weighted random set of
* machines is sampled on a ReceiveMessage call. This means
* only the messages on the sampled machines are returned. If the number
* of messages in the queue is small (less than 1000), it is likely you
* will get fewer messages than you requested per
* ReceiveMessage call. If the number of messages in the
* queue is extremely small, you might not receive any messages in a
* particular ReceiveMessage response; in which case you
* should repeat the request.
*
*
* For each message returned, the response includes the following:
*
*
*
* -
* Message body
*
*
* -
* MD5 digest of the message body. For information about MD5, go to
* http://www.faqs.org/rfcs/rfc1321.html
* .
*
*
* -
* Message ID you received when you sent the message to the queue.
*
*
* -
* Receipt handle.
*
*
*
*
*
* The receipt handle is the identifier you must provide when deleting
* the message. For more information, see
* Queue and Message Identifiers
* in the Amazon SQS Developer Guide .
*
*
*
* You can provide the VisibilityTimeout parameter in your
* request, which will be applied to the messages that Amazon SQS returns
* in the response. If you do not include the parameter, the overall
* visibility timeout for the queue is used for the returned messages.
* For more information, see
* Visibility Timeout
* in the Amazon SQS Developer Guide .
*
*
*
* NOTE: Going forward, new attributes might be added. If you are
* writing code that calls this action, we recommend that you structure
* your code so that it can handle new attributes gracefully.
*
*
* @see com.amazonaws.services.sqs.AmazonSQS#receiveMessage(ReceiveMessageRequest)
*/
public class ReceiveMessageRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The URL of the Amazon SQS queue to take action on.
*/
private String queueUrl;
/**
* A list of attributes that need to be returned along with each message.
* The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*/
private com.amazonaws.internal.ListWithAutoConstructFlag attributeNames;
/**
* The maximum number of messages to return. Amazon SQS never returns
* more messages than this value but may return fewer. All of the
* messages are not necessarily returned.
*/
private Integer maxNumberOfMessages;
/**
* The duration (in seconds) that the received messages are hidden from
* subsequent retrieve requests after being retrieved by a
* ReceiveMessage request.
*/
private Integer visibilityTimeout;
/**
* The duration (in seconds) for which the call will wait for a message
* to arrive in the queue before returning. If a message is available,
* the call will return sooner than WaitTimeSeconds.
*/
private Integer waitTimeSeconds;
/**
* Default constructor for a new ReceiveMessageRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public ReceiveMessageRequest() {}
/**
* Constructs a new ReceiveMessageRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param queueUrl The URL of the Amazon SQS queue to take action on.
*/
public ReceiveMessageRequest(String queueUrl) {
setQueueUrl(queueUrl);
}
/**
* The URL of the Amazon SQS queue to take action on.
*
* @return The URL of the Amazon SQS queue to take action on.
*/
public String getQueueUrl() {
return queueUrl;
}
/**
* The URL of the Amazon SQS queue to take action on.
*
* @param queueUrl The URL of the Amazon SQS queue to take action on.
*/
public void setQueueUrl(String queueUrl) {
this.queueUrl = queueUrl;
}
/**
* The URL of the Amazon SQS queue to take action on.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param queueUrl The URL of the Amazon SQS queue to take action on.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ReceiveMessageRequest withQueueUrl(String queueUrl) {
this.queueUrl = queueUrl;
return this;
}
/**
* A list of attributes that need to be returned along with each message.
*
The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*
* @return A list of attributes that need to be returned along with each message.
* The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*/
public java.util.List getAttributeNames() {
if (attributeNames == null) {
attributeNames = new com.amazonaws.internal.ListWithAutoConstructFlag();
attributeNames.setAutoConstruct(true);
}
return attributeNames;
}
/**
* A list of attributes that need to be returned along with each message.
* The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*
* @param attributeNames A list of attributes that need to be returned along with each message.
* The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*/
public void setAttributeNames(java.util.Collection attributeNames) {
if (attributeNames == null) {
this.attributeNames = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag attributeNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(attributeNames.size());
attributeNamesCopy.addAll(attributeNames);
this.attributeNames = attributeNamesCopy;
}
/**
* A list of attributes that need to be returned along with each message.
* The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param attributeNames A list of attributes that need to be returned along with each message.
*
The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ReceiveMessageRequest withAttributeNames(String... attributeNames) {
if (getAttributeNames() == null) setAttributeNames(new java.util.ArrayList(attributeNames.length));
for (String value : attributeNames) {
getAttributeNames().add(value);
}
return this;
}
/**
* A list of attributes that need to be returned along with each message.
* The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param attributeNames A list of attributes that need to be returned along with each message.
*
The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ReceiveMessageRequest withAttributeNames(java.util.Collection attributeNames) {
if (attributeNames == null) {
this.attributeNames = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag attributeNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(attributeNames.size());
attributeNamesCopy.addAll(attributeNames);
this.attributeNames = attributeNamesCopy;
}
return this;
}
/**
* A list of attributes that need to be returned along with each message.
* The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param attributeNames A list of attributes that need to be returned along with each message.
*
The following lists the names and descriptions of the attributes
* that can be returned:
All - returns all
* values.ApproximateFirstReceiveTimestamp -
* returns the time when the message was first received (epoch time in
* milliseconds).ApproximateReceiveCount - returns
* the number of times a message has been received but not deleted.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).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ReceiveMessageRequest withAttributeNames(QueueAttributeName... attributeNames) {
java.util.ArrayList attributeNamesCopy = new java.util.ArrayList(attributeNames.length);
for (QueueAttributeName member : attributeNames) {
attributeNamesCopy.add(member.toString());
}
if (getAttributeNames() == null) {
setAttributeNames(attributeNamesCopy);
} else {
getAttributeNames().addAll(attributeNamesCopy);
}
return this;
}
/**
* The maximum number of messages to return. Amazon SQS never returns
* more messages than this value but may return fewer. All of the
* messages are not necessarily returned.
*
* @return The maximum number of messages to return. Amazon SQS never returns
* more messages than this value but may return fewer.
All of the
* messages are not necessarily returned.
*/
public Integer getMaxNumberOfMessages() {
return maxNumberOfMessages;
}
/**
* The maximum number of messages to return. Amazon SQS never returns
* more messages than this value but may return fewer.
All of the
* messages are not necessarily returned.
*
* @param maxNumberOfMessages The maximum number of messages to return. Amazon SQS never returns
* more messages than this value but may return fewer.
All of the
* messages are not necessarily returned.
*/
public void setMaxNumberOfMessages(Integer maxNumberOfMessages) {
this.maxNumberOfMessages = maxNumberOfMessages;
}
/**
* The maximum number of messages to return. Amazon SQS never returns
* more messages than this value but may return fewer.
All of the
* messages are not necessarily returned.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param maxNumberOfMessages The maximum number of messages to return. Amazon SQS never returns
* more messages than this value but may return fewer.
All of the
* messages are not necessarily returned.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ReceiveMessageRequest withMaxNumberOfMessages(Integer maxNumberOfMessages) {
this.maxNumberOfMessages = maxNumberOfMessages;
return this;
}
/**
* The duration (in seconds) that the received messages are hidden from
* subsequent retrieve requests after being retrieved by a
* ReceiveMessage request.
*
* @return The duration (in seconds) that the received messages are hidden from
* subsequent retrieve requests after being retrieved by a
* ReceiveMessage request.
*/
public Integer getVisibilityTimeout() {
return visibilityTimeout;
}
/**
* The duration (in seconds) that the received messages are hidden from
* subsequent retrieve requests after being retrieved by a
* ReceiveMessage request.
*
* @param visibilityTimeout The duration (in seconds) that the received messages are hidden from
* subsequent retrieve requests after being retrieved by a
* ReceiveMessage request.
*/
public void setVisibilityTimeout(Integer visibilityTimeout) {
this.visibilityTimeout = visibilityTimeout;
}
/**
* The duration (in seconds) that the received messages are hidden from
* subsequent retrieve requests after being retrieved by a
* ReceiveMessage request.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param visibilityTimeout The duration (in seconds) that the received messages are hidden from
* subsequent retrieve requests after being retrieved by a
* ReceiveMessage request.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ReceiveMessageRequest withVisibilityTimeout(Integer visibilityTimeout) {
this.visibilityTimeout = visibilityTimeout;
return this;
}
/**
* The duration (in seconds) for which the call will wait for a message
* to arrive in the queue before returning. If a message is available,
* the call will return sooner than WaitTimeSeconds.
*
* @return The duration (in seconds) for which the call will wait for a message
* to arrive in the queue before returning. If a message is available,
* the call will return sooner than WaitTimeSeconds.
*/
public Integer getWaitTimeSeconds() {
return waitTimeSeconds;
}
/**
* The duration (in seconds) for which the call will wait for a message
* to arrive in the queue before returning. If a message is available,
* the call will return sooner than WaitTimeSeconds.
*
* @param waitTimeSeconds The duration (in seconds) for which the call will wait for a message
* to arrive in the queue before returning. If a message is available,
* the call will return sooner than WaitTimeSeconds.
*/
public void setWaitTimeSeconds(Integer waitTimeSeconds) {
this.waitTimeSeconds = waitTimeSeconds;
}
/**
* The duration (in seconds) for which the call will wait for a message
* to arrive in the queue before returning. If a message is available,
* the call will return sooner than WaitTimeSeconds.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param waitTimeSeconds The duration (in seconds) for which the call will wait for a message
* to arrive in the queue before returning. If a message is available,
* the call will return sooner than WaitTimeSeconds.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ReceiveMessageRequest withWaitTimeSeconds(Integer waitTimeSeconds) {
this.waitTimeSeconds = waitTimeSeconds;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getQueueUrl() != null) sb.append("QueueUrl: " + getQueueUrl() + ",");
if (getAttributeNames() != null) sb.append("AttributeNames: " + getAttributeNames() + ",");
if (getMaxNumberOfMessages() != null) sb.append("MaxNumberOfMessages: " + getMaxNumberOfMessages() + ",");
if (getVisibilityTimeout() != null) sb.append("VisibilityTimeout: " + getVisibilityTimeout() + ",");
if (getWaitTimeSeconds() != null) sb.append("WaitTimeSeconds: " + getWaitTimeSeconds() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getQueueUrl() == null) ? 0 : getQueueUrl().hashCode());
hashCode = prime * hashCode + ((getAttributeNames() == null) ? 0 : getAttributeNames().hashCode());
hashCode = prime * hashCode + ((getMaxNumberOfMessages() == null) ? 0 : getMaxNumberOfMessages().hashCode());
hashCode = prime * hashCode + ((getVisibilityTimeout() == null) ? 0 : getVisibilityTimeout().hashCode());
hashCode = prime * hashCode + ((getWaitTimeSeconds() == null) ? 0 : getWaitTimeSeconds().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof ReceiveMessageRequest == false) return false;
ReceiveMessageRequest other = (ReceiveMessageRequest)obj;
if (other.getQueueUrl() == null ^ this.getQueueUrl() == null) return false;
if (other.getQueueUrl() != null && other.getQueueUrl().equals(this.getQueueUrl()) == false) return false;
if (other.getAttributeNames() == null ^ this.getAttributeNames() == null) return false;
if (other.getAttributeNames() != null && other.getAttributeNames().equals(this.getAttributeNames()) == false) return false;
if (other.getMaxNumberOfMessages() == null ^ this.getMaxNumberOfMessages() == null) return false;
if (other.getMaxNumberOfMessages() != null && other.getMaxNumberOfMessages().equals(this.getMaxNumberOfMessages()) == false) return false;
if (other.getVisibilityTimeout() == null ^ this.getVisibilityTimeout() == null) return false;
if (other.getVisibilityTimeout() != null && other.getVisibilityTimeout().equals(this.getVisibilityTimeout()) == false) return false;
if (other.getWaitTimeSeconds() == null ^ this.getWaitTimeSeconds() == null) return false;
if (other.getWaitTimeSeconds() != null && other.getWaitTimeSeconds().equals(this.getWaitTimeSeconds()) == false) return false;
return true;
}
}