com.amazonaws.services.sqs.model.CreateQueueRequest Maven / Gradle / Ivy
Show all versions of aws-sdk-android Show documentation
/*
* Copyright 2010-2015 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#createQueue(CreateQueueRequest) CreateQueue operation}.
*
* Creates a new queue, or returns the URL of an existing one. When you
* request CreateQueue , you provide a name for the queue.
* To successfully create a new queue, you must provide a name that is
* unique within the scope of your own queues.
*
*
* NOTE: If you delete a queue, you must wait at least 60 seconds
* before creating a queue with the same name.
*
*
* You may pass one or more attributes in the request. If you do not
* provide a value for any attribute, the queue will have the default
* value for that attribute. Permitted attributes are the same that can
* be set using SetQueueAttributes.
*
*
* NOTE: Use GetQueueUrl to get a queue's URL. GetQueueUrl
* requires only the QueueName parameter.
*
*
* If you provide the name of an existing queue, along with the exact
* names and values of all the queue's attributes,
* CreateQueue returns the queue URL for the existing queue.
* If the queue name, attribute names, or attribute values do not match
* an existing queue, CreateQueue returns an error.
*
*
* NOTE:Some API actions take lists of parameters. These lists are
* specified using the param.n notation. Values of n are integers
* starting from 1. For example, a parameter list with two elements looks
* like this:
*
*
* &Attribute.1=this
*
*
* &Attribute.2=that
*
*
* @see com.amazonaws.services.sqs.AmazonSQS#createQueue(CreateQueueRequest)
*/
public class CreateQueueRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name for the queue to be created.
*/
private String queueName;
/**
* A map of attributes with their corresponding values. The following
* lists the names, descriptions, and values of the special request
* parameters the CreateQueue action uses:
* DelaySeconds - The time in seconds that the delivery
* of all messages in the queue will be delayed. An integer from 0 to 900
* (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
* message can contain before Amazon SQS rejects it. An integer from 1024
* bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
* attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
* SQS retains a message. Integer representing seconds, from 60 (1
* minute) to 1209600 (14 days). The default for this attribute is 345600
* (4 days).Policy - The queue's policy. A valid
* form-url-encoded policy. For more information about policy structure,
* see Basic
* Policy Structure in the Amazon SQS Developer Guide. For
* more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds - The time for which a
* ReceiveMessage call will wait for a message to arrive. An
* integer from 0 to 20 (seconds). The default for this attribute is 0.
* VisibilityTimeout - The visibility timeout for
* the queue. An integer from 0 to 43200 (12 hours). The default for this
* attribute is 30. For more information about visibility timeout, see Visibility
* Timeout in the Amazon SQS Developer Guide.
*/
private java.util.Map attributes;
/**
* Default constructor for a new CreateQueueRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public CreateQueueRequest() {}
/**
* Constructs a new CreateQueueRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param queueName The name for the queue to be created.
*/
public CreateQueueRequest(String queueName) {
setQueueName(queueName);
}
/**
* The name for the queue to be created.
*
* @return The name for the queue to be created.
*/
public String getQueueName() {
return queueName;
}
/**
* The name for the queue to be created.
*
* @param queueName The name for the queue to be created.
*/
public void setQueueName(String queueName) {
this.queueName = queueName;
}
/**
* The name for the queue to be created.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param queueName The name for the queue to be created.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateQueueRequest withQueueName(String queueName) {
this.queueName = queueName;
return this;
}
/**
* A map of attributes with their corresponding values.
The following
* lists the names, descriptions, and values of the special request
* parameters the CreateQueue action uses:
* DelaySeconds - The time in seconds that the delivery
* of all messages in the queue will be delayed. An integer from 0 to 900
* (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
* message can contain before Amazon SQS rejects it. An integer from 1024
* bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
* attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
* SQS retains a message. Integer representing seconds, from 60 (1
* minute) to 1209600 (14 days). The default for this attribute is 345600
* (4 days).Policy - The queue's policy. A valid
* form-url-encoded policy. For more information about policy structure,
* see Basic
* Policy Structure in the Amazon SQS Developer Guide. For
* more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds - The time for which a
* ReceiveMessage call will wait for a message to arrive. An
* integer from 0 to 20 (seconds). The default for this attribute is 0.
* VisibilityTimeout - The visibility timeout for
* the queue. An integer from 0 to 43200 (12 hours). The default for this
* attribute is 30. For more information about visibility timeout, see Visibility
* Timeout in the Amazon SQS Developer Guide.
*
* @return A map of attributes with their corresponding values. The following
* lists the names, descriptions, and values of the special request
* parameters the CreateQueue action uses:
* DelaySeconds - The time in seconds that the delivery
* of all messages in the queue will be delayed. An integer from 0 to 900
* (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
* message can contain before Amazon SQS rejects it. An integer from 1024
* bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
* attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
* SQS retains a message. Integer representing seconds, from 60 (1
* minute) to 1209600 (14 days). The default for this attribute is 345600
* (4 days).Policy - The queue's policy. A valid
* form-url-encoded policy. For more information about policy structure,
* see Basic
* Policy Structure in the Amazon SQS Developer Guide. For
* more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds - The time for which a
* ReceiveMessage call will wait for a message to arrive. An
* integer from 0 to 20 (seconds). The default for this attribute is 0.
* VisibilityTimeout - The visibility timeout for
* the queue. An integer from 0 to 43200 (12 hours). The default for this
* attribute is 30. For more information about visibility timeout, see Visibility
* Timeout in the Amazon SQS Developer Guide.
*/
public java.util.Map getAttributes() {
if (attributes == null) {
attributes = new java.util.HashMap();
}
return attributes;
}
/**
* A map of attributes with their corresponding values. The following
* lists the names, descriptions, and values of the special request
* parameters the CreateQueue action uses:
* DelaySeconds - The time in seconds that the delivery
* of all messages in the queue will be delayed. An integer from 0 to 900
* (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
* message can contain before Amazon SQS rejects it. An integer from 1024
* bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
* attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
* SQS retains a message. Integer representing seconds, from 60 (1
* minute) to 1209600 (14 days). The default for this attribute is 345600
* (4 days).Policy - The queue's policy. A valid
* form-url-encoded policy. For more information about policy structure,
* see Basic
* Policy Structure in the Amazon SQS Developer Guide. For
* more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds - The time for which a
* ReceiveMessage call will wait for a message to arrive. An
* integer from 0 to 20 (seconds). The default for this attribute is 0.
* VisibilityTimeout - The visibility timeout for
* the queue. An integer from 0 to 43200 (12 hours). The default for this
* attribute is 30. For more information about visibility timeout, see Visibility
* Timeout in the Amazon SQS Developer Guide.
*
* @param attributes A map of attributes with their corresponding values. The following
* lists the names, descriptions, and values of the special request
* parameters the CreateQueue action uses:
* DelaySeconds - The time in seconds that the delivery
* of all messages in the queue will be delayed. An integer from 0 to 900
* (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
* message can contain before Amazon SQS rejects it. An integer from 1024
* bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
* attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
* SQS retains a message. Integer representing seconds, from 60 (1
* minute) to 1209600 (14 days). The default for this attribute is 345600
* (4 days).Policy - The queue's policy. A valid
* form-url-encoded policy. For more information about policy structure,
* see Basic
* Policy Structure in the Amazon SQS Developer Guide. For
* more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds - The time for which a
* ReceiveMessage call will wait for a message to arrive. An
* integer from 0 to 20 (seconds). The default for this attribute is 0.
* VisibilityTimeout - The visibility timeout for
* the queue. An integer from 0 to 43200 (12 hours). The default for this
* attribute is 30. For more information about visibility timeout, see Visibility
* Timeout in the Amazon SQS Developer Guide.
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = attributes;
}
/**
* A map of attributes with their corresponding values. The following
* lists the names, descriptions, and values of the special request
* parameters the CreateQueue action uses:
* DelaySeconds - The time in seconds that the delivery
* of all messages in the queue will be delayed. An integer from 0 to 900
* (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
* message can contain before Amazon SQS rejects it. An integer from 1024
* bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
* attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
* SQS retains a message. Integer representing seconds, from 60 (1
* minute) to 1209600 (14 days). The default for this attribute is 345600
* (4 days).Policy - The queue's policy. A valid
* form-url-encoded policy. For more information about policy structure,
* see Basic
* Policy Structure in the Amazon SQS Developer Guide. For
* more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds - The time for which a
* ReceiveMessage call will wait for a message to arrive. An
* integer from 0 to 20 (seconds). The default for this attribute is 0.
* VisibilityTimeout - The visibility timeout for
* the queue. An integer from 0 to 43200 (12 hours). The default for this
* attribute is 30. For more information about visibility timeout, see Visibility
* Timeout in the Amazon SQS Developer Guide.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param attributes A map of attributes with their corresponding values.
The following
* lists the names, descriptions, and values of the special request
* parameters the CreateQueue action uses:
* DelaySeconds - The time in seconds that the delivery
* of all messages in the queue will be delayed. An integer from 0 to 900
* (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
* message can contain before Amazon SQS rejects it. An integer from 1024
* bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
* attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
* SQS retains a message. Integer representing seconds, from 60 (1
* minute) to 1209600 (14 days). The default for this attribute is 345600
* (4 days).Policy - The queue's policy. A valid
* form-url-encoded policy. For more information about policy structure,
* see Basic
* Policy Structure in the Amazon SQS Developer Guide. For
* more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds - The time for which a
* ReceiveMessage call will wait for a message to arrive. An
* integer from 0 to 20 (seconds). The default for this attribute is 0.
* VisibilityTimeout - The visibility timeout for
* the queue. An integer from 0 to 43200 (12 hours). The default for this
* attribute is 30. For more information about visibility timeout, see Visibility
* Timeout in the Amazon SQS Developer Guide.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateQueueRequest withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* A map of attributes with their corresponding values. The following
* lists the names, descriptions, and values of the special request
* parameters the CreateQueue action uses:
* DelaySeconds - The time in seconds that the delivery
* of all messages in the queue will be delayed. An integer from 0 to 900
* (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
* message can contain before Amazon SQS rejects it. An integer from 1024
* bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
* attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
* SQS retains a message. Integer representing seconds, from 60 (1
* minute) to 1209600 (14 days). The default for this attribute is 345600
* (4 days).Policy - The queue's policy. A valid
* form-url-encoded policy. For more information about policy structure,
* see Basic
* Policy Structure in the Amazon SQS Developer Guide. For
* more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds - The time for which a
* ReceiveMessage call will wait for a message to arrive. An
* integer from 0 to 20 (seconds). The default for this attribute is 0.
* VisibilityTimeout - The visibility timeout for
* the queue. An integer from 0 to 43200 (12 hours). The default for this
* attribute is 30. For more information about visibility timeout, see Visibility
* Timeout in the Amazon SQS Developer Guide.
*
* The method adds a new key-value pair into Attributes parameter, and
* returns a reference to this object so that method calls can be chained
* together.
*
* @param key The key of the entry to be added into Attributes.
* @param value The corresponding value of the entry to be added into Attributes.
*/
public CreateQueueRequest addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new java.util.HashMap();
}
if (this.attributes.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.attributes.put(key, value);
return this;
}
/**
* Removes all the entries added into Attributes.
*
* Returns a reference to this object so that method calls can be chained together.
*/
public CreateQueueRequest clearAttributesEntries() {
this.attributes = null;
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 (getQueueName() != null) sb.append("QueueName: " + getQueueName() + ",");
if (getAttributes() != null) sb.append("Attributes: " + getAttributes() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getQueueName() == null) ? 0 : getQueueName().hashCode());
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof CreateQueueRequest == false) return false;
CreateQueueRequest other = (CreateQueueRequest)obj;
if (other.getQueueName() == null ^ this.getQueueName() == null) return false;
if (other.getQueueName() != null && other.getQueueName().equals(this.getQueueName()) == false) return false;
if (other.getAttributes() == null ^ this.getAttributes() == null) return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false) return false;
return true;
}
}