software.amazon.awssdk.services.sns.model

Class SetPlatformApplicationAttributesRequest

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.SetPlatformApplicationAttributesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetPlatformApplicationAttributesRequest.Builder,SetPlatformApplicationAttributesRequest>

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

Input for SetPlatformApplicationAttributes action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SetPlatformApplicationAttributesRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributes() A map of the platform application attributes.
static SetPlatformApplicationAttributesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	platformApplicationArn() PlatformApplicationArn for SetPlatformApplicationAttributes action.
List<SdkField<?>>	sdkFields()
static Class<? extends SetPlatformApplicationAttributesRequest.Builder>	serializableBuilderClass()
SetPlatformApplicationAttributesRequest.Builder	toBuilder()
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

platformApplicationArn

public final String platformApplicationArn()

PlatformApplicationArn for SetPlatformApplicationAttributes action.

Returns:

PlatformApplicationArn for SetPlatformApplicationAttributes action.

hasAttributes

public final boolean hasAttributes()

Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

attributes

public final Map<String,String> attributes()

A map of the platform application attributes. Attributes in this map include the following:

• PlatformCredential – The credential received from the notification service. For APNS and APNS_SANDBOX, PlatformCredential is private key. For GCM (Firebase Cloud Messaging), PlatformCredential is API key. For ADM, PlatformCredential is client secret.

• PlatformPrincipal – The principal received from the notification service. For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal. For ADM, PlatformPrincipal is client id.

• EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.

• EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.

• EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.

• EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

• SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

• FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

• SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAttributes() to see if a value was sent in this field.

Returns:

A map of the platform application attributes. Attributes in this map include the following:

• PlatformCredential – The credential received from the notification service. For APNS and APNS_SANDBOX, PlatformCredential is private key. For GCM (Firebase Cloud Messaging), PlatformCredential is API key. For ADM, PlatformCredential is client secret.

• PlatformPrincipal – The principal received from the notification service. For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal. For ADM, PlatformPrincipal is client id.

• EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.

• EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.

• EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.

• EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

• SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

• FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

• SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

toBuilder

public SetPlatformApplicationAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetPlatformApplicationAttributesRequest.Builder,SetPlatformApplicationAttributesRequest>

Specified by:

toBuilder in class SnsRequest

builder

public static SetPlatformApplicationAttributesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetPlatformApplicationAttributesRequest.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