Class AddPermissionRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The action the client wants to allow for the specified principal.The AWS account number of the principal who will be given permission.getLabel()
The unique identification of the permission you're setting (e.g.,AliceSendMessage
).The URL of the Amazon SQS queue to take action on.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 will be given permission.void
The unique identification of the permission you're setting (e.g.,AliceSendMessage
).void
setQueueUrl
(String queueUrl) The URL of the Amazon SQS queue to take action on.toString()
Returns a string representation of this object; useful for testing and debugging.withActions
(String... actions) The action the client wants to allow for the specified principal.withActions
(Collection<String> actions) The action the client wants to allow for the specified principal.withAWSAccountIds
(String... aWSAccountIds) The AWS account number of the principal who will be given permission.withAWSAccountIds
(Collection<String> aWSAccountIds) The AWS account number of the principal who will be given permission.The unique identification of the permission you're setting (e.g.,AliceSendMessage
).withQueueUrl
(String queueUrl) The URL of the Amazon SQS queue to take action on.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
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 take action on.Queue URLs are case-sensitive.
label
- The unique identification of the permission you're setting (e.g.,AliceSendMessage
). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.aWSAccountIds
- The AWS account number of the principal who will be 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 SQS Developer Guide.actions
- The action the client wants to allow for the specified principal. The following are valid values:* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.Specifying
SendMessage
,DeleteMessage
, orChangeMessageVisibility
for theActionName.n
also grants permissions for the corresponding batch versions of those actions:SendMessageBatch
,DeleteMessageBatch
, andChangeMessageVisibilityBatch
.
-
-
Method Details
-
setQueueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
- Parameters:
queueUrl
- The URL of the Amazon SQS queue to take action on.Queue URLs are case-sensitive.
-
getQueueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
- Returns:
- The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
-
withQueueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
- Parameters:
queueUrl
- The URL of the Amazon SQS queue to take action on.Queue URLs are case-sensitive.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLabel
The unique identification of the permission you're setting (e.g.,
AliceSendMessage
). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.- Parameters:
label
- The unique identification of the permission you're setting (e.g.,AliceSendMessage
). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
-
getLabel
The unique identification of the permission you're setting (e.g.,
AliceSendMessage
). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.- Returns:
- The unique identification of the permission you're setting (e.g.,
AliceSendMessage
). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
-
withLabel
The unique identification of the permission you're setting (e.g.,
AliceSendMessage
). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.- Parameters:
label
- The unique identification of the permission you're setting (e.g.,AliceSendMessage
). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAWSAccountIds
The AWS account number of the principal who will be 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 SQS Developer Guide.
- Returns:
- The AWS account number of the principal who will be 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 SQS Developer Guide.
-
setAWSAccountIds
The AWS account number of the principal who will be 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 SQS Developer Guide.
- Parameters:
aWSAccountIds
- The AWS account number of the principal who will be 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 SQS Developer Guide.
-
withAWSAccountIds
The AWS account number of the principal who will be 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 SQS Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setAWSAccountIds(java.util.Collection)
orwithAWSAccountIds(java.util.Collection)
if you want to override the existing values.- Parameters:
aWSAccountIds
- The AWS account number of the principal who will be 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 SQS Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withAWSAccountIds
The AWS account number of the principal who will be 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 SQS Developer Guide.
- Parameters:
aWSAccountIds
- The AWS account number of the principal who will be 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 SQS Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getActions
The action the client wants to allow for the specified principal. The following are valid values:
* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.Specifying
SendMessage
,DeleteMessage
, orChangeMessageVisibility
for theActionName.n
also grants permissions for the corresponding batch versions of those actions:SendMessageBatch
,DeleteMessageBatch
, andChangeMessageVisibilityBatch
.- Returns:
- The action the client wants to allow for the specified principal.
The following are valid values:
* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.Specifying
SendMessage
,DeleteMessage
, orChangeMessageVisibility
for theActionName.n
also grants permissions for the corresponding batch versions of those actions:SendMessageBatch
,DeleteMessageBatch
, andChangeMessageVisibilityBatch
.
-
setActions
The action the client wants to allow for the specified principal. The following are valid values:
* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.Specifying
SendMessage
,DeleteMessage
, orChangeMessageVisibility
for theActionName.n
also grants permissions for the corresponding batch versions of those actions:SendMessageBatch
,DeleteMessageBatch
, andChangeMessageVisibilityBatch
.- Parameters:
actions
- The action the client wants to allow for the specified principal. The following are valid values:* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.Specifying
SendMessage
,DeleteMessage
, orChangeMessageVisibility
for theActionName.n
also grants permissions for the corresponding batch versions of those actions:SendMessageBatch
,DeleteMessageBatch
, andChangeMessageVisibilityBatch
.
-
withActions
The action the client wants to allow for the specified principal. The following are valid values:
* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.Specifying
SendMessage
,DeleteMessage
, orChangeMessageVisibility
for theActionName.n
also grants permissions for the corresponding batch versions of those actions:SendMessageBatch
,DeleteMessageBatch
, andChangeMessageVisibilityBatch
.NOTE: This method appends the values to the existing list (if any). Use
setActions(java.util.Collection)
orwithActions(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 are valid values:* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.Specifying
SendMessage
,DeleteMessage
, orChangeMessageVisibility
for theActionName.n
also grants permissions for the corresponding batch versions of those actions:SendMessageBatch
,DeleteMessageBatch
, andChangeMessageVisibilityBatch
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withActions
The action the client wants to allow for the specified principal. The following are valid values:
* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.Specifying
SendMessage
,DeleteMessage
, orChangeMessageVisibility
for theActionName.n
also grants permissions for the corresponding batch versions of those actions:SendMessageBatch
,DeleteMessageBatch
, andChangeMessageVisibilityBatch
.- Parameters:
actions
- The action the client wants to allow for the specified principal. The following are valid values:* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.Specifying
SendMessage
,DeleteMessage
, orChangeMessageVisibility
for theActionName.n
also grants permissions for the corresponding batch versions of those actions:SendMessageBatch
,DeleteMessageBatch
, andChangeMessageVisibilityBatch
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-