/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sns.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* Input for SetPlatformApplicationAttributes action. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SetPlatformApplicationAttributesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* PlatformApplicationArn for SetPlatformApplicationAttributes action. *

*/ private String platformApplicationArn; /** *

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

*/ private com.amazonaws.internal.SdkInternalMap attributes; /** *

* PlatformApplicationArn for SetPlatformApplicationAttributes action. *

* * @param platformApplicationArn * PlatformApplicationArn for SetPlatformApplicationAttributes action. */ public void setPlatformApplicationArn(String platformApplicationArn) { this.platformApplicationArn = platformApplicationArn; } /** *

* PlatformApplicationArn for SetPlatformApplicationAttributes action. *

* * @return PlatformApplicationArn for SetPlatformApplicationAttributes action. */ public String getPlatformApplicationArn() { return this.platformApplicationArn; } /** *

* PlatformApplicationArn for SetPlatformApplicationAttributes action. *

* * @param platformApplicationArn * PlatformApplicationArn for SetPlatformApplicationAttributes action. * @return Returns a reference to this object so that method calls can be chained together. */ public SetPlatformApplicationAttributesRequest withPlatformApplicationArn(String platformApplicationArn) { setPlatformApplicationArn(platformApplicationArn); return this; } /** *

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

* * @return 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. *
*

getAttributes() { if (attributes == null) { attributes = new com.amazonaws.internal.SdkInternalMap(); } return 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. *
*

* * @param 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. *
*

attributes) { this.attributes = attributes == null ? null : new com.amazonaws.internal.SdkInternalMap(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. *
*

* * @param 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. *
*

attributes) { setAttributes(attributes); return this; } /** * Add a single Attributes entry * * @see SetPlatformApplicationAttributesRequest#withAttributes * @returns a reference to this object so that method calls can be chained together. */ public SetPlatformApplicationAttributesRequest addAttributesEntry(String key, String value) { if (null == this.attributes) { this.attributes = new com.amazonaws.internal.SdkInternalMap(); } if (this.attributes.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.attributes.put(key, value); return this; } /** * Removes all the entries added into Attributes. * * @return Returns a reference to this object so that method calls can be chained together. */ public SetPlatformApplicationAttributesRequest clearAttributesEntries() { this.attributes = null; return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getPlatformApplicationArn() != null) sb.append("PlatformApplicationArn: ").append(getPlatformApplicationArn()).append(","); if (getAttributes() != null) sb.append("Attributes: ").append(getAttributes()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SetPlatformApplicationAttributesRequest == false) return false; SetPlatformApplicationAttributesRequest other = (SetPlatformApplicationAttributesRequest) obj; if (other.getPlatformApplicationArn() == null ^ this.getPlatformApplicationArn() == null) return false; if (other.getPlatformApplicationArn() != null && other.getPlatformApplicationArn().equals(this.getPlatformApplicationArn()) == false) return false; if (other.getAttributes() == null ^ this.getAttributes() == null) return false; if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getPlatformApplicationArn() == null) ? 0 : getPlatformApplicationArn().hashCode()); hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode()); return hashCode; } @Override public SetPlatformApplicationAttributesRequest clone() { return (SetPlatformApplicationAttributesRequest) super.clone(); } }