@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 Amazon Web Services account numbers of the principals who are to receive
permission.
|
static AddPermissionRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasActions()
For responses, this returns true if the service returned a value for the Actions property.
|
boolean |
hasAwsAccountIds()
For responses, this returns true if the service returned a value for the AWSAccountIds property.
|
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.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AddPermissionRequest.Builder> |
serializableBuilderClass() |
AddPermissionRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String queueUrl()
The URL of the Amazon SQS queue to which permissions are added.
Queue URLs and names are case-sensitive.
Queue URLs and names are case-sensitive.
public final 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 final boolean hasAwsAccountIds()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> awsAccountIds()
The Amazon Web Services account numbers of the principals who are to receive permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAwsAccountIds() method.
public final boolean hasActions()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<String> actions()
The action the client wants to allow for the specified principal. Valid values: the name of any action or
*.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasActions() method.
*.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS 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()
toBuilder in interface ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>toBuilder in class SqsRequestpublic static AddPermissionRequest.Builder builder()
public static Class<? extends AddPermissionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.