Class SetPlatformApplicationAttributesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SetPlatformApplicationAttributesRequest.Builder,
SetPlatformApplicationAttributesRequest>
Input for SetPlatformApplicationAttributes
action.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionA map of the platform application attributes.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 Attributes property.final int
hashCode()
final String
PlatformApplicationArn
forSetPlatformApplicationAttributes
action.static Class
<? extends SetPlatformApplicationAttributesRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.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
-
platformApplicationArn
PlatformApplicationArn
forSetPlatformApplicationAttributes
action.- Returns:
PlatformApplicationArn
forSetPlatformApplicationAttributes
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 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. -
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,
PlatformCredential
is 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) using key credentials, there is no
PlatformPrincipal
. ThePlatformCredential
isAPI key
. -
For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal
. ThePlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command:SERVICE_JSON=`jq @json <<< cat service.json`
.
-
-
PlatformPrincipal
– The principal received from the notification service.-
For ADM,
PlatformPrincipal
is 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 whichEndpointCreated
event notifications are sent. -
EventEndpointDeleted
– Topic ARN to whichEndpointDeleted
event notifications are sent. -
EventEndpointUpdated
– Topic ARN to whichEndpointUpdate
event notifications are sent. -
EventDeliveryFailure
– Topic ARN to whichDeliveryFailure
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,
PlatformCredential
is 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) using key credentials, there is no
PlatformPrincipal
. ThePlatformCredential
isAPI key
. -
For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal
. ThePlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command:SERVICE_JSON=`jq @json <<< cat service.json`
.
-
-
PlatformPrincipal
– The principal received from the notification service.-
For ADM,
PlatformPrincipal
is 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 whichEndpointCreated
event notifications are sent. -
EventEndpointDeleted
– Topic ARN to whichEndpointDeleted
event notifications are sent. -
EventEndpointUpdated
– Topic ARN to whichEndpointUpdate
event notifications are sent. -
EventDeliveryFailure
– Topic ARN to whichDeliveryFailure
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
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<SetPlatformApplicationAttributesRequest.Builder,
SetPlatformApplicationAttributesRequest> - Specified by:
toBuilder
in classSnsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends SetPlatformApplicationAttributesRequest.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
-