com.amazonaws.services.sqs.model

Class CreateQueueRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.CreateQueueRequest

All Implemented Interfaces:

Serializable

public class CreateQueueRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateQueue operation.

The CreateQueue action 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.

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.

If you provide the name of an existing queue, a new queue isn't created. If the values of attributes provided with the request match up with those on the existing queue, the queue URL is returned. Otherwise, a QueueNameExists error is returned.

See Also:

AmazonSQS.createQueue(CreateQueueRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateQueueRequest() Default constructor for a new CreateQueueRequest object.
CreateQueueRequest(String queueName) Constructs a new CreateQueueRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
CreateQueueRequest	addAttributesEntry(String key, String value) A map of attributes with their corresponding values.
CreateQueueRequest	clearAttributesEntries() Removes all the entries added into Attributes.
boolean	equals(Object obj)
Map<String,String>	getAttributes() A map of attributes with their corresponding values.
String	getQueueName() The name for the queue to be created.
int	hashCode()
void	setAttributes(Map<String,String> attributes) A map of attributes with their corresponding values.
void	setQueueName(String queueName) The name for the queue to be created.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateQueueRequest	withAttributes(Map<String,String> attributes) A map of attributes with their corresponding values.
CreateQueueRequest	withQueueName(String queueName) The name for the queue to be created.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateQueueRequest

public CreateQueueRequest()

Default constructor for a new CreateQueueRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

CreateQueueRequest

public CreateQueueRequest(String queueName)

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

Parameters:

queueName - The name for the queue to be created.

Method Detail

getQueueName

public String getQueueName()

The name for the queue to be created.

Returns:

The name for the queue to be created.

setQueueName

public void setQueueName(String queueName)

The name for the queue to be created.

Parameters:

queueName - The name for the queue to be created.

withQueueName

public CreateQueueRequest withQueueName(String queueName)

The name for the queue to be created.

Returns a reference to this object so that method calls can be chained together.

Parameters:

queueName - The name for the queue to be created.

Returns:

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

getAttributes

public Map<String,String> getAttributes()

A map of attributes with their corresponding values.

Returns:

A map of attributes with their corresponding values.

setAttributes

public void setAttributes(Map<String,String> attributes)

A map of attributes with their corresponding values.

Parameters:

attributes - A map of attributes with their corresponding values.

withAttributes

public CreateQueueRequest withAttributes(Map<String,String> attributes)

A map of attributes with their corresponding values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

attributes - A map of attributes with their corresponding values.

Returns:

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

addAttributesEntry

public CreateQueueRequest addAttributesEntry(String key,
                                    String value)

A map of attributes with their corresponding values.

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.

Parameters:

key - The key of the entry to be added into Attributes.

value - The corresponding value of the entry to be added into Attributes.

clearAttributesEntries

public CreateQueueRequest clearAttributesEntries()

Removes all the entries added into Attributes.

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object