SetPlatformApplicationAttributesRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SetPlatformApplicationAttributesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` For responses, this returns true if the service returned a value for the Attributes property.
`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()
```
    For responses, this returns true if the service returned a value for the Attributes 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.
  - 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 ADM, PlatformCredentialis client secret.
      
      For Apple Services using certificate credentials, PlatformCredential is private key.
      
      For Apple Services using token credentials, PlatformCredential is signing key.
      
      For GCM (Firebase Cloud Messaging), PlatformCredential is API key.
    - PlatformPrincipal – The principal received from the notification service.
      
      For ADM, PlatformPrincipalis client id.
      
      For Apple Services using certificate credentials, PlatformPrincipal is SSL certificate.
      
      For Apple Services using token credentials, PlatformPrincipal is signing key ID.
      
      For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal.
    - 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.
    The following attributes only apply to APNs token-based authentication:
    - ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.
    - ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.
    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 hasAttributes() method.
    Returns:
    A map of the platform application attributes. Attributes in this map include the following:
    
    PlatformCredential – The credential received from the notification service.
    
    For ADM, PlatformCredentialis client secret.
    
    For Apple Services using certificate credentials, PlatformCredential is private key.
    
    For Apple Services using token credentials, PlatformCredential is signing key.
    
    For GCM (Firebase Cloud Messaging), PlatformCredential is API key.
    
    PlatformPrincipal – The principal received from the notification service.
    
    For ADM, PlatformPrincipalis client id.
    
    For Apple Services using certificate credentials, PlatformPrincipal is SSL certificate.
    
    For Apple Services using token credentials, PlatformPrincipal is signing key ID.
    
    For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal.
    
    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.
    
    The following attributes only apply to APNs token-based authentication:
    
    ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.
    
    ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.
  - 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

Class SetPlatformApplicationAttributesRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

platformApplicationArn

hasAttributes

attributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields