@Generated(value="software.amazon.awssdk:codegen") public final class AddPermissionRequest extends SqsRequest implements ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
AddPermissionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
List<String> |
actions()
The action the client wants to allow for the specified principal.
|
List<String> |
awsAccountIds()
The AWS account number of the principal who is given permission.
|
static AddPermissionRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
label()
The unique identification of the permission you're setting (for example,
AliceSendMessage ). |
String |
queueUrl()
The URL of the Amazon SQS queue to which permissions are added.
|
static Class<? extends AddPermissionRequest.Builder> |
serializableBuilderClass() |
AddPermissionRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String queueUrl()
The URL of the Amazon SQS queue to which permissions are added.
Queue URLs are case-sensitive.
Queue URLs are case-sensitive.
public 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 (
_
).
AliceSendMessage
).
Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-
), and
underscores (_
).public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<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
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
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
.
public AddPermissionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>
toBuilder
in class SqsRequest
public static AddPermissionRequest.Builder builder()
public static Class<? extends AddPermissionRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.