Class AddPermissionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AddPermissionRequest.Builder,
AddPermissionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe action you want to allow for the specified principal(s).The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions.static AddPermissionRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the ActionNames property.final boolean
For responses, this returns true if the service returned a value for the AWSAccountIds property.final int
hashCode()
final String
label()
A unique identifier for the new policy statement.static Class
<? extends AddPermissionRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
topicArn()
The ARN of the topic whose access control policy you wish to modify.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
topicArn
The ARN of the topic whose access control policy you wish to modify.
- Returns:
- The ARN of the topic whose access control policy you wish to modify.
-
label
A unique identifier for the new policy statement.
- Returns:
- A unique identifier for the new policy statement.
-
hasAwsAccountIds
public final boolean hasAwsAccountIds()For responses, this returns true if the service returned a value for the AWSAccountIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
awsAccountIds
The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.
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.- Returns:
- The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.
-
hasActionNames
public final boolean hasActionNames()For responses, this returns true if the service returned a value for the ActionNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
actionNames
The action you want to allow for the specified principal(s).
Valid values: Any Amazon SNS action name, for example
Publish
.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
hasActionNames()
method.- Returns:
- The action you want to allow for the specified principal(s).
Valid values: Any Amazon SNS action name, for example
Publish
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AddPermissionRequest.Builder,
AddPermissionRequest> - Specified by:
toBuilder
in classSnsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-