Package software.amazon.awssdk.services.sns.model

Class AddPermissionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sns.model.SnsRequest

software.amazon.awssdk.services.sns.model.AddPermissionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AddPermissionRequest
extends SnsRequest
implements ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AddPermissionRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	actionNames()	The action you want to allow for the specified principal(s).
List<String>	awsAccountIds()	The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions.
static AddPermissionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActionNames()	For responses, this returns true if the service returned a value for the ActionNames property.
boolean	hasAwsAccountIds()	For responses, this returns true if the service returned a value for the AWSAccountIds property.
int	hashCode()
String	label()	A unique identifier for the new policy statement.
List<SdkField<?>>	sdkFields()
static Class<? extends AddPermissionRequest.Builder>	serializableBuilderClass()
AddPermissionRequest.Builder	toBuilder()
String	topicArn()	The ARN of the topic whose access control policy you wish to modify.
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

topicArn

public final String 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

public final String 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 the 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.

awsAccountIds

public final List<String> 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 the 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.

actionNames

public final List<String> 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

public AddPermissionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

Specified by:

toBuilder in class SnsRequest

builder

public static AddPermissionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AddPermissionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo