com.amazonaws.services.sqs.model

Class AddPermissionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.AddPermissionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AddPermissionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AddPermissionRequest() Default constructor for AddPermissionRequest object.
AddPermissionRequest(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions) Constructs a new AddPermissionRequest object.

Method Summary

Modifier and Type	Method and Description
AddPermissionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getActions() The action the client wants to allow for the specified principal.
List<String>	getAWSAccountIds() The AWS account number of the principal who is given permission.
String	getLabel() The unique identification of the permission you're setting (for example, AliceSendMessage).
String	getQueueUrl() The URL of the Amazon SQS queue to which permissions are added.
int	hashCode()
void	setActions(Collection<String> actions) The action the client wants to allow for the specified principal.
void	setAWSAccountIds(Collection<String> aWSAccountIds) The AWS account number of the principal who is given permission.
void	setLabel(String label) The unique identification of the permission you're setting (for example, AliceSendMessage).
void	setQueueUrl(String queueUrl) The URL of the Amazon SQS queue to which permissions are added.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AddPermissionRequest	withActions(Collection<String> actions) The action the client wants to allow for the specified principal.
AddPermissionRequest	withActions(String... actions) The action the client wants to allow for the specified principal.
AddPermissionRequest	withAWSAccountIds(Collection<String> aWSAccountIds) The AWS account number of the principal who is given permission.
AddPermissionRequest	withAWSAccountIds(String... aWSAccountIds) The AWS account number of the principal who is given permission.
AddPermissionRequest	withLabel(String label) The unique identification of the permission you're setting (for example, AliceSendMessage).
AddPermissionRequest	withQueueUrl(String queueUrl) The URL of the Amazon SQS queue to which permissions are added.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AddPermissionRequest

public AddPermissionRequest()

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

AddPermissionRequest

public AddPermissionRequest(String queueUrl,
                            String label,
                            List<String> aWSAccountIds,
                            List<String> actions)

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

Parameters:

queueUrl - The URL of the Amazon SQS queue to which permissions are added.

Queue URLs are case-sensitive.

label - The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

aWSAccountIds - The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

actions - The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon Simple Queue Service Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Method Detail

setQueueUrl

public void setQueueUrl(String queueUrl)

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs are case-sensitive.

Parameters:

queueUrl - The URL of the Amazon SQS queue to which permissions are added.

Queue URLs are case-sensitive.

getQueueUrl

public String getQueueUrl()

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs are case-sensitive.

Returns:

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs are case-sensitive.

withQueueUrl

public AddPermissionRequest withQueueUrl(String queueUrl)

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs are case-sensitive.

Parameters:

queueUrl - The URL of the Amazon SQS queue to which permissions are added.

Queue URLs are case-sensitive.

Returns:

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

setLabel

public void setLabel(String label)

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores ( _).

Parameters:

label - The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

getLabel

public String getLabel()

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores ( _).

Returns:

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

withLabel

public AddPermissionRequest withLabel(String label)

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores ( _).

Parameters:

label - The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

Returns:

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

getAWSAccountIds

public List<String> getAWSAccountIds()

The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

Returns:

The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

setAWSAccountIds

public void setAWSAccountIds(Collection<String> aWSAccountIds)

The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

Parameters:

aWSAccountIds - The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

withAWSAccountIds

public AddPermissionRequest withAWSAccountIds(String... aWSAccountIds)

The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

NOTE: This method appends the values to the existing list (if any). Use setAWSAccountIds(java.util.Collection) or withAWSAccountIds(java.util.Collection) if you want to override the existing values.

Parameters:

aWSAccountIds - The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

Returns:

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

withAWSAccountIds

public AddPermissionRequest withAWSAccountIds(Collection<String> aWSAccountIds)

The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

Parameters:

aWSAccountIds - The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

Returns:

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

getActions

public List<String> getActions()

The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon Simple Queue Service Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Returns:

The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon Simple Queue Service Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

setActions

public void setActions(Collection<String> actions)

The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon Simple Queue Service Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Parameters:

actions - The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon Simple Queue Service Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

withActions

public AddPermissionRequest withActions(String... actions)

The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon Simple Queue Service Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

NOTE: This method appends the values to the existing list (if any). Use setActions(java.util.Collection) or withActions(java.util.Collection) if you want to override the existing values.

Parameters:

actions - The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon Simple Queue Service Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Returns:

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

withActions

public AddPermissionRequest withActions(Collection<String> actions)

The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon Simple Queue Service Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Parameters:

actions - The action the client wants to allow for the specified principal. The following values are valid:

• *

• ChangeMessageVisibility

• DeleteMessage

• GetQueueAttributes

• GetQueueUrl

• ReceiveMessage

• SendMessage

For more information about these actions, see Understanding Permissions in the Amazon Simple Queue Service Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Returns:

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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AddPermissionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()