/* * Copyright 2010-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 com.amazonaws.AmazonWebServiceRequest; /** *

* Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S * or email, or if the endpoint and the topic are not in the same Amazon Web * Services account, the endpoint owner must run the * ConfirmSubscription action to confirm the subscription. *

*

* You call the ConfirmSubscription action with the token from the * subscription response. Confirmation tokens are valid for three days. *

*

* This action is throttled at 100 transactions per second (TPS). *

*/ public class SubscribeRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The ARN of the topic you want to subscribe to. *

*/ private String topicArn; /** *

* The protocol that you want to use. Supported protocols include: *

* */ private String protocol; /** *

* The endpoint that you want to receive notifications. Endpoints vary by * protocol: *

* */ private String endpoint; /** *

* A map of attributes with their corresponding values. *

*

* The following lists the names, descriptions, and values of the special * request parameters that the Subscribe action uses: *

* *

* The following attribute applies only to Amazon Kinesis Data Firehose * delivery stream subscriptions: *

* */ private java.util.Map attributes = new java.util.HashMap(); /** *

* Sets whether the response from the Subscribe request * includes the subscription ARN, even if the subscription is not yet * confirmed. *

*

* If you set this parameter to true, the response includes the * ARN in all cases, even if the subscription is not yet confirmed. In * addition to the ARN for confirmed subscriptions, the response also * includes the pending subscription ARN value for * subscriptions that aren't yet confirmed. A subscription becomes confirmed * when the subscriber calls the ConfirmSubscription action * with a confirmation token. *

*

*

* The default value is false. *

*/ private Boolean returnSubscriptionArn; /** * Default constructor for SubscribeRequest object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. */ public SubscribeRequest() { } /** * Constructs a new SubscribeRequest object. Callers should use the setter * or fluent setter (with...) methods to initialize any additional object * members. * * @param topicArn

* The ARN of the topic you want to subscribe to. *

* @param protocol

* The protocol that you want to use. Supported protocols * include: *

* * @param endpoint

* The endpoint that you want to receive notifications. Endpoints * vary by protocol: *

* */ public SubscribeRequest(String topicArn, String protocol, String endpoint) { setTopicArn(topicArn); setProtocol(protocol); setEndpoint(endpoint); } /** *

* The ARN of the topic you want to subscribe to. *

* * @return

* The ARN of the topic you want to subscribe to. *

*/ public String getTopicArn() { return topicArn; } /** *

* The ARN of the topic you want to subscribe to. *

* * @param topicArn

* The ARN of the topic you want to subscribe to. *

*/ public void setTopicArn(String topicArn) { this.topicArn = topicArn; } /** *

* The ARN of the topic you want to subscribe to. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param topicArn

* The ARN of the topic you want to subscribe to. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SubscribeRequest withTopicArn(String topicArn) { this.topicArn = topicArn; return this; } /** *

* The protocol that you want to use. Supported protocols include: *

* * * @return

* The protocol that you want to use. Supported protocols include: *

* */ public String getProtocol() { return protocol; } /** *

* The protocol that you want to use. Supported protocols include: *

* * * @param protocol

* The protocol that you want to use. Supported protocols * include: *

* */ public void setProtocol(String protocol) { this.protocol = protocol; } /** *

* The protocol that you want to use. Supported protocols include: *

* *

* Returns a reference to this object so that method calls can be chained * together. * * @param protocol

* The protocol that you want to use. Supported protocols * include: *

* * @return A reference to this updated object so that method calls can be * chained together. */ public SubscribeRequest withProtocol(String protocol) { this.protocol = protocol; return this; } /** *

* The endpoint that you want to receive notifications. Endpoints vary by * protocol: *

* * * @return

* The endpoint that you want to receive notifications. Endpoints * vary by protocol: *

* */ public String getEndpoint() { return endpoint; } /** *

* The endpoint that you want to receive notifications. Endpoints vary by * protocol: *

* * * @param endpoint

* The endpoint that you want to receive notifications. Endpoints * vary by protocol: *

* */ public void setEndpoint(String endpoint) { this.endpoint = endpoint; } /** *

* The endpoint that you want to receive notifications. Endpoints vary by * protocol: *

* *

* Returns a reference to this object so that method calls can be chained * together. * * @param endpoint

* The endpoint that you want to receive notifications. Endpoints * vary by protocol: *

* * @return A reference to this updated object so that method calls can be * chained together. */ public SubscribeRequest withEndpoint(String endpoint) { this.endpoint = endpoint; return this; } /** *

* A map of attributes with their corresponding values. *

*

* The following lists the names, descriptions, and values of the special * request parameters that the Subscribe action uses: *

* *

* The following attribute applies only to Amazon Kinesis Data Firehose * delivery stream subscriptions: *

* * * @return

* A map of attributes with their corresponding values. *

*

* The following lists the names, descriptions, and values of the * special request parameters that the Subscribe action * uses: *

* *

* The following attribute applies only to Amazon Kinesis Data * Firehose delivery stream subscriptions: *

* */ public java.util.Map getAttributes() { return attributes; } /** *

* A map of attributes with their corresponding values. *

*

* The following lists the names, descriptions, and values of the special * request parameters that the Subscribe action uses: *

*
    *
  • *

    * DeliveryPolicy – The policy that defines how Amazon SNS * retries failed deliveries to HTTP/S endpoints. *

    *
    • *
  • *

    * FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic. *

    *
    • *
  • *

    * FilterPolicyScope – This attribute lets you choose the * filtering scope by using one of the following string value types: *

    *
      *
    • *

      * MessageAttributes (default) – The filter is applied on the * message attributes. *

      *
      • *
    • *

      * MessageBody – The filter is applied on the message body. *

      *
      • *
    *
    • *
  • *

    * RawMessageDelivery – When set to true, enables * raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates * the need for the endpoints to process JSON formatting, which is otherwise * created for Amazon SNS metadata. *

    *
    • *
  • *

    * RedrivePolicy – When specified, sends undeliverable messages * to the specified Amazon SQS dead-letter queue. Messages that can't be * delivered due to client errors (for example, when the subscribed endpoint * is unreachable) or server errors (for example, when the service that * powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing. *

    *
    • *
*

* The following attribute applies only to Amazon Kinesis Data Firehose * delivery stream subscriptions: *

*
    *
  • *

    * SubscriptionRoleArn – The ARN of the IAM role that has the * following: *

    *
      *
    • *

      * Permission to write to the Kinesis Data Firehose delivery stream *

      *
      • *
    • *

      * Amazon SNS listed as a trusted entity *

      *
      • *
    *

    * Specifying a valid ARN for this attribute is required for Kinesis Data * Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon * SNS Developer Guide. *

    *
    • *
* * @param attributes

* A map of attributes with their corresponding values. *

*

* The following lists the names, descriptions, and values of the * special request parameters that the Subscribe * action uses: *

*
    *
  • *

    * DeliveryPolicy – The policy that defines how * Amazon SNS retries failed deliveries to HTTP/S endpoints. *

    *
    • *
  • *

    * FilterPolicy – The simple JSON object that lets * your subscriber receive only a subset of messages, rather than * receiving every message published to the topic. *

    *
    • *
  • *

    * FilterPolicyScope – This attribute lets you * choose the filtering scope by using one of the following * string value types: *

    *
      *
    • *

      * MessageAttributes (default) – The filter is * applied on the message attributes. *

      *
      • *
    • *

      * MessageBody – The filter is applied on the * message body. *

      *
      • *
    *
    • *
  • *

    * RawMessageDelivery – When set to * true, enables raw message delivery to Amazon SQS * or HTTP/S endpoints. This eliminates the need for the * endpoints to process JSON formatting, which is otherwise * created for Amazon SNS metadata. *

    *
    • *
  • *

    * RedrivePolicy – When specified, sends * undeliverable messages to the specified Amazon SQS dead-letter * queue. Messages that can't be delivered due to client errors * (for example, when the subscribed endpoint is unreachable) or * server errors (for example, when the service that powers the * subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing. *

    *
    • *
*

* The following attribute applies only to Amazon Kinesis Data * Firehose delivery stream subscriptions: *

*
    *
  • *

    * SubscriptionRoleArn – The ARN of the IAM role * that has the following: *

    *
      *
    • *

      * Permission to write to the Kinesis Data Firehose delivery * stream *

      *
      • *
    • *

      * Amazon SNS listed as a trusted entity *

      *
      • *
    *

    * Specifying a valid ARN for this attribute is required for * Kinesis Data Firehose delivery stream subscriptions. For more * information, see Fanout to Kinesis Data Firehose delivery streams in the * Amazon SNS Developer Guide. *

    *
    • *
*/ public void setAttributes(java.util.Map attributes) { this.attributes = attributes; } /** *

* A map of attributes with their corresponding values. *

*

* The following lists the names, descriptions, and values of the special * request parameters that the Subscribe action uses: *

*
    *
  • *

    * DeliveryPolicy – The policy that defines how Amazon SNS * retries failed deliveries to HTTP/S endpoints. *

    *
    • *
  • *

    * FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic. *

    *
    • *
  • *

    * FilterPolicyScope – This attribute lets you choose the * filtering scope by using one of the following string value types: *

    *
      *
    • *

      * MessageAttributes (default) – The filter is applied on the * message attributes. *

      *
      • *
    • *

      * MessageBody – The filter is applied on the message body. *

      *
      • *
    *
    • *
  • *

    * RawMessageDelivery – When set to true, enables * raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates * the need for the endpoints to process JSON formatting, which is otherwise * created for Amazon SNS metadata. *

    *
    • *
  • *

    * RedrivePolicy – When specified, sends undeliverable messages * to the specified Amazon SQS dead-letter queue. Messages that can't be * delivered due to client errors (for example, when the subscribed endpoint * is unreachable) or server errors (for example, when the service that * powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing. *

    *
    • *
*

* The following attribute applies only to Amazon Kinesis Data Firehose * delivery stream subscriptions: *

*
    *
  • *

    * SubscriptionRoleArn – The ARN of the IAM role that has the * following: *

    *
      *
    • *

      * Permission to write to the Kinesis Data Firehose delivery stream *

      *
      • *
    • *

      * Amazon SNS listed as a trusted entity *

      *
      • *
    *

    * Specifying a valid ARN for this attribute is required for Kinesis Data * Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon * SNS Developer Guide. *

    *
    • *
*

* Returns a reference to this object so that method calls can be chained * together. * * @param attributes

* A map of attributes with their corresponding values. *

*

* The following lists the names, descriptions, and values of the * special request parameters that the Subscribe * action uses: *

*
    *
  • *

    * DeliveryPolicy – The policy that defines how * Amazon SNS retries failed deliveries to HTTP/S endpoints. *

    *
    • *
  • *

    * FilterPolicy – The simple JSON object that lets * your subscriber receive only a subset of messages, rather than * receiving every message published to the topic. *

    *
    • *
  • *

    * FilterPolicyScope – This attribute lets you * choose the filtering scope by using one of the following * string value types: *

    *
      *
    • *

      * MessageAttributes (default) – The filter is * applied on the message attributes. *

      *
      • *
    • *

      * MessageBody – The filter is applied on the * message body. *

      *
      • *
    *
    • *
  • *

    * RawMessageDelivery – When set to * true, enables raw message delivery to Amazon SQS * or HTTP/S endpoints. This eliminates the need for the * endpoints to process JSON formatting, which is otherwise * created for Amazon SNS metadata. *

    *
    • *
  • *

    * RedrivePolicy – When specified, sends * undeliverable messages to the specified Amazon SQS dead-letter * queue. Messages that can't be delivered due to client errors * (for example, when the subscribed endpoint is unreachable) or * server errors (for example, when the service that powers the * subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing. *

    *
    • *
*

* The following attribute applies only to Amazon Kinesis Data * Firehose delivery stream subscriptions: *

*
    *
  • *

    * SubscriptionRoleArn – The ARN of the IAM role * that has the following: *

    *
      *
    • *

      * Permission to write to the Kinesis Data Firehose delivery * stream *

      *
      • *
    • *

      * Amazon SNS listed as a trusted entity *

      *
      • *
    *

    * Specifying a valid ARN for this attribute is required for * Kinesis Data Firehose delivery stream subscriptions. For more * information, see Fanout to Kinesis Data Firehose delivery streams in the * Amazon SNS Developer Guide. *

    *
    • *
* @return A reference to this updated object so that method calls can be * chained together. */ public SubscribeRequest withAttributes(java.util.Map attributes) { this.attributes = attributes; return this; } /** *

* A map of attributes with their corresponding values. *

*

* The following lists the names, descriptions, and values of the special * request parameters that the Subscribe action uses: *

*
    *
  • *

    * DeliveryPolicy – The policy that defines how Amazon SNS * retries failed deliveries to HTTP/S endpoints. *

    *
    • *
  • *

    * FilterPolicy – The simple JSON object that lets your * subscriber receive only a subset of messages, rather than receiving every * message published to the topic. *

    *
    • *
  • *

    * FilterPolicyScope – This attribute lets you choose the * filtering scope by using one of the following string value types: *

    *
      *
    • *

      * MessageAttributes (default) – The filter is applied on the * message attributes. *

      *
      • *
    • *

      * MessageBody – The filter is applied on the message body. *

      *
      • *
    *
    • *
  • *

    * RawMessageDelivery – When set to true, enables * raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates * the need for the endpoints to process JSON formatting, which is otherwise * created for Amazon SNS metadata. *

    *
    • *
  • *

    * RedrivePolicy – When specified, sends undeliverable messages * to the specified Amazon SQS dead-letter queue. Messages that can't be * delivered due to client errors (for example, when the subscribed endpoint * is unreachable) or server errors (for example, when the service that * powers the subscribed endpoint becomes unavailable) are held in the * dead-letter queue for further analysis or reprocessing. *

    *
    • *
*

* The following attribute applies only to Amazon Kinesis Data Firehose * delivery stream subscriptions: *

*
    *
  • *

    * SubscriptionRoleArn – The ARN of the IAM role that has the * following: *

    *
      *
    • *

      * Permission to write to the Kinesis Data Firehose delivery stream *

      *
      • *
    • *

      * Amazon SNS listed as a trusted entity *

      *
      • *
    *

    * Specifying a valid ARN for this attribute is required for Kinesis Data * Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon * SNS Developer Guide. *

    *
    • *
*

* The method adds a new key-value pair into Attributes parameter, and * returns a reference to this object so that method calls can be chained * together. * * @param key The key of the entry to be added into Attributes. * @param value The corresponding value of the entry to be added into * Attributes. * @return A reference to this updated object so that method calls can be * chained together. */ public SubscribeRequest addAttributesEntry(String key, String value) { if (null == this.attributes) { this.attributes = new java.util.HashMap(); } 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. *

* Returns a reference to this object so that method calls can be chained * together. */ public SubscribeRequest clearAttributesEntries() { this.attributes = null; return this; } /** *

* Sets whether the response from the Subscribe request * includes the subscription ARN, even if the subscription is not yet * confirmed. *

*

* If you set this parameter to true, the response includes the * ARN in all cases, even if the subscription is not yet confirmed. In * addition to the ARN for confirmed subscriptions, the response also * includes the pending subscription ARN value for * subscriptions that aren't yet confirmed. A subscription becomes confirmed * when the subscriber calls the ConfirmSubscription action * with a confirmation token. *

*

*

* The default value is false. *

* * @return

* Sets whether the response from the Subscribe request * includes the subscription ARN, even if the subscription is not * yet confirmed. *

*

* If you set this parameter to true, the response * includes the ARN in all cases, even if the subscription is not * yet confirmed. In addition to the ARN for confirmed * subscriptions, the response also includes the * pending subscription ARN value for subscriptions * that aren't yet confirmed. A subscription becomes confirmed when * the subscriber calls the ConfirmSubscription action * with a confirmation token. *

*

*

* The default value is false. *

*/ public Boolean isReturnSubscriptionArn() { return returnSubscriptionArn; } /** *

* Sets whether the response from the Subscribe request * includes the subscription ARN, even if the subscription is not yet * confirmed. *

*

* If you set this parameter to true, the response includes the * ARN in all cases, even if the subscription is not yet confirmed. In * addition to the ARN for confirmed subscriptions, the response also * includes the pending subscription ARN value for * subscriptions that aren't yet confirmed. A subscription becomes confirmed * when the subscriber calls the ConfirmSubscription action * with a confirmation token. *

*

*

* The default value is false. *

* * @return

* Sets whether the response from the Subscribe request * includes the subscription ARN, even if the subscription is not * yet confirmed. *

*

* If you set this parameter to true, the response * includes the ARN in all cases, even if the subscription is not * yet confirmed. In addition to the ARN for confirmed * subscriptions, the response also includes the * pending subscription ARN value for subscriptions * that aren't yet confirmed. A subscription becomes confirmed when * the subscriber calls the ConfirmSubscription action * with a confirmation token. *

*

*

* The default value is false. *

*/ public Boolean getReturnSubscriptionArn() { return returnSubscriptionArn; } /** *

* Sets whether the response from the Subscribe request * includes the subscription ARN, even if the subscription is not yet * confirmed. *

*

* If you set this parameter to true, the response includes the * ARN in all cases, even if the subscription is not yet confirmed. In * addition to the ARN for confirmed subscriptions, the response also * includes the pending subscription ARN value for * subscriptions that aren't yet confirmed. A subscription becomes confirmed * when the subscriber calls the ConfirmSubscription action * with a confirmation token. *

*

*

* The default value is false. *

* * @param returnSubscriptionArn

* Sets whether the response from the Subscribe * request includes the subscription ARN, even if the * subscription is not yet confirmed. *

*

* If you set this parameter to true, the response * includes the ARN in all cases, even if the subscription is not * yet confirmed. In addition to the ARN for confirmed * subscriptions, the response also includes the * pending subscription ARN value for subscriptions * that aren't yet confirmed. A subscription becomes confirmed * when the subscriber calls the ConfirmSubscription * action with a confirmation token. *

*

*

* The default value is false. *

*/ public void setReturnSubscriptionArn(Boolean returnSubscriptionArn) { this.returnSubscriptionArn = returnSubscriptionArn; } /** *

* Sets whether the response from the Subscribe request * includes the subscription ARN, even if the subscription is not yet * confirmed. *

*

* If you set this parameter to true, the response includes the * ARN in all cases, even if the subscription is not yet confirmed. In * addition to the ARN for confirmed subscriptions, the response also * includes the pending subscription ARN value for * subscriptions that aren't yet confirmed. A subscription becomes confirmed * when the subscriber calls the ConfirmSubscription action * with a confirmation token. *

*

*

* The default value is false. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param returnSubscriptionArn

* Sets whether the response from the Subscribe * request includes the subscription ARN, even if the * subscription is not yet confirmed. *

*

* If you set this parameter to true, the response * includes the ARN in all cases, even if the subscription is not * yet confirmed. In addition to the ARN for confirmed * subscriptions, the response also includes the * pending subscription ARN value for subscriptions * that aren't yet confirmed. A subscription becomes confirmed * when the subscriber calls the ConfirmSubscription * action with a confirmation token. *

*

*

* The default value is false. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SubscribeRequest withReturnSubscriptionArn(Boolean returnSubscriptionArn) { this.returnSubscriptionArn = returnSubscriptionArn; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getTopicArn() != null) sb.append("TopicArn: " + getTopicArn() + ","); if (getProtocol() != null) sb.append("Protocol: " + getProtocol() + ","); if (getEndpoint() != null) sb.append("Endpoint: " + getEndpoint() + ","); if (getAttributes() != null) sb.append("Attributes: " + getAttributes() + ","); if (getReturnSubscriptionArn() != null) sb.append("ReturnSubscriptionArn: " + getReturnSubscriptionArn()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getTopicArn() == null) ? 0 : getTopicArn().hashCode()); hashCode = prime * hashCode + ((getProtocol() == null) ? 0 : getProtocol().hashCode()); hashCode = prime * hashCode + ((getEndpoint() == null) ? 0 : getEndpoint().hashCode()); hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode()); hashCode = prime * hashCode + ((getReturnSubscriptionArn() == null) ? 0 : getReturnSubscriptionArn().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SubscribeRequest == false) return false; SubscribeRequest other = (SubscribeRequest) obj; if (other.getTopicArn() == null ^ this.getTopicArn() == null) return false; if (other.getTopicArn() != null && other.getTopicArn().equals(this.getTopicArn()) == false) return false; if (other.getProtocol() == null ^ this.getProtocol() == null) return false; if (other.getProtocol() != null && other.getProtocol().equals(this.getProtocol()) == false) return false; if (other.getEndpoint() == null ^ this.getEndpoint() == null) return false; if (other.getEndpoint() != null && other.getEndpoint().equals(this.getEndpoint()) == false) return false; if (other.getAttributes() == null ^ this.getAttributes() == null) return false; if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false) return false; if (other.getReturnSubscriptionArn() == null ^ this.getReturnSubscriptionArn() == null) return false; if (other.getReturnSubscriptionArn() != null && other.getReturnSubscriptionArn().equals(this.getReturnSubscriptionArn()) == false) return false; return true; } }