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:

ToCopyableBuilder<SetPlatformApplicationAttributesRequest.Builder,SetPlatformApplicationAttributesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public 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)
<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	platformApplicationArn() PlatformApplicationArn for SetPlatformApplicationAttributes action.
static Class<? extends SetPlatformApplicationAttributesRequest.Builder>	serializableBuilderClass()
SetPlatformApplicationAttributesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

platformApplicationArn

public String platformApplicationArn()

PlatformApplicationArn for SetPlatformApplicationAttributes action.

Returns:

PlatformApplicationArn for SetPlatformApplicationAttributes action.

attributes

public 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/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret".

• PlatformPrincipal -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id".

• EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.

• EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.

• EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.

• EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be 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.

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/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret".

• PlatformPrincipal -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id".

• EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.

• EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.

• EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.

• EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be 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()

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 interface ToCopyableBuilder<SetPlatformApplicationAttributesRequest.Builder,SetPlatformApplicationAttributesRequest>

Specified by:

toBuilder in class SNSRequest

Returns:

a builder for type T

builder

public static SetPlatformApplicationAttributesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

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