/* * 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 Subscribe action. *

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

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

*/ private String topicArn; /** *

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

*
* http – delivery of JSON-encoded message via HTTP POST *
*
*
* https – delivery of JSON-encoded message via HTTPS POST *
*
*
* email – delivery of message via SMTP *
*
*
* email-json – delivery of JSON-encoded message via SMTP *
*
*
* sms – delivery of message via SMS *
*
*
* sqs – delivery of JSON-encoded message to an Amazon SQS queue *
*
*
* application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device *
*
*
* lambda – delivery of JSON-encoded message to an Lambda function *
*
*
* firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream. *
*

*/ private String protocol; /** *

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

*
* For the http protocol, the (public) endpoint is a URL beginning with http://. *
*
*
* For the https protocol, the (public) endpoint is a URL beginning with https://. *
*
*
* For the email protocol, the endpoint is an email address. *
*
*
* For the email-json protocol, the endpoint is an email address. *
*
*
* For the sms protocol, the endpoint is a phone number of an SMS-enabled device. *
*
*
* For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue. *
*
*
* For the application protocol, the endpoint is the EndpointArn of a mobile app and device. *
*
*
* For the lambda protocol, the endpoint is the ARN of an Lambda function. *
*
*
* For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery * stream. *
*

*/ 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: *

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

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

* 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 the object after creating it. */ 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:

*
* http – delivery of JSON-encoded message via HTTP POST *
*
*
* https – delivery of JSON-encoded message via HTTPS POST *
*
*
* email – delivery of message via SMTP *
*
*
* email-json – delivery of JSON-encoded message via SMTP *
*
*
* sms – delivery of message via SMS *
*
*
* sqs – delivery of JSON-encoded message to an Amazon SQS queue *
*
*
* application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device *
*
*
* lambda – delivery of JSON-encoded message to an Lambda function *
*
*
* firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery * stream. *
*

*
* For the http protocol, the (public) endpoint is a URL beginning with http://. *
*
*
* For the https protocol, the (public) endpoint is a URL beginning with https://. *
*
*
* For the email protocol, the endpoint is an email address. *
*
*
* For the email-json protocol, the endpoint is an email address. *
*
*
* For the sms protocol, the endpoint is a phone number of an SMS-enabled device. *
*
*
* For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue. *
*
*
* For the application protocol, the endpoint is the EndpointArn of a mobile app and device. *
*
*
* For the lambda protocol, the endpoint is the ARN of an Lambda function. *
*
*
* For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose * delivery stream. *
*

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

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

*
* http – delivery of JSON-encoded message via HTTP POST *
*
*
* https – delivery of JSON-encoded message via HTTPS POST *
*
*
* email – delivery of message via SMTP *
*
*
* email-json – delivery of JSON-encoded message via SMTP *
*
*
* sms – delivery of message via SMS *
*
*
* sqs – delivery of JSON-encoded message to an Amazon SQS queue *
*
*
* application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device *
*
*
* lambda – delivery of JSON-encoded message to an Lambda function *
*
*
* firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream. *
*

*
* http – delivery of JSON-encoded message via HTTP POST *
*
*
* https – delivery of JSON-encoded message via HTTPS POST *
*
*
* email – delivery of message via SMTP *
*
*
* email-json – delivery of JSON-encoded message via SMTP *
*
*
* sms – delivery of message via SMS *
*
*
* sqs – delivery of JSON-encoded message to an Amazon SQS queue *
*
*
* application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device *
*
*
* lambda – delivery of JSON-encoded message to an Lambda function *
*
*
* firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery * stream. *
*

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

*
* http – delivery of JSON-encoded message via HTTP POST *
*
*
* https – delivery of JSON-encoded message via HTTPS POST *
*
*
* email – delivery of message via SMTP *
*
*
* email-json – delivery of JSON-encoded message via SMTP *
*
*
* sms – delivery of message via SMS *
*
*
* sqs – delivery of JSON-encoded message to an Amazon SQS queue *
*
*
* application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device *
*
*
* lambda – delivery of JSON-encoded message to an Lambda function *
*
*
* firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream. *
*

*
* http – delivery of JSON-encoded message via HTTP POST *
*
*
* https – delivery of JSON-encoded message via HTTPS POST *
*
*
* email – delivery of message via SMTP *
*
*
* email-json – delivery of JSON-encoded message via SMTP *
*
*
* sms – delivery of message via SMS *
*
*
* sqs – delivery of JSON-encoded message to an Amazon SQS queue *
*
*
* application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device *
*
*
* lambda – delivery of JSON-encoded message to an Lambda function *
*
*
* firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery * stream. *
*

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

*
* http – delivery of JSON-encoded message via HTTP POST *
*
*
* https – delivery of JSON-encoded message via HTTPS POST *
*
*
* email – delivery of message via SMTP *
*
*
* email-json – delivery of JSON-encoded message via SMTP *
*
*
* sms – delivery of message via SMS *
*
*
* sqs – delivery of JSON-encoded message to an Amazon SQS queue *
*
*
* application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device *
*
*
* lambda – delivery of JSON-encoded message to an Lambda function *
*
*
* firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream. *
*

*
* http – delivery of JSON-encoded message via HTTP POST *
*
*
* https – delivery of JSON-encoded message via HTTPS POST *
*
*
* email – delivery of message via SMTP *
*
*
* email-json – delivery of JSON-encoded message via SMTP *
*
*
* sms – delivery of message via SMS *
*
*
* sqs – delivery of JSON-encoded message to an Amazon SQS queue *
*
*
* application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device *
*
*
* lambda – delivery of JSON-encoded message to an Lambda function *
*
*
* firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery * stream. *
*

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

*
* For the http protocol, the (public) endpoint is a URL beginning with http://. *
*
*
* For the https protocol, the (public) endpoint is a URL beginning with https://. *
*
*
* For the email protocol, the endpoint is an email address. *
*
*
* For the email-json protocol, the endpoint is an email address. *
*
*
* For the sms protocol, the endpoint is a phone number of an SMS-enabled device. *
*
*
* For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue. *
*
*
* For the application protocol, the endpoint is the EndpointArn of a mobile app and device. *
*
*
* For the lambda protocol, the endpoint is the ARN of an Lambda function. *
*
*
* For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery * stream. *
*

*
* For the http protocol, the (public) endpoint is a URL beginning with http://. *
*
*
* For the https protocol, the (public) endpoint is a URL beginning with https://. *
*
*
* For the email protocol, the endpoint is an email address. *
*
*
* For the email-json protocol, the endpoint is an email address. *
*
*
* For the sms protocol, the endpoint is a phone number of an SMS-enabled device. *
*
*
* For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue. *
*
*
* For the application protocol, the endpoint is the EndpointArn of a mobile app and device. *
*
*
* For the lambda protocol, the endpoint is the ARN of an Lambda function. *
*
*
* For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose * delivery stream. *
*

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

*
* For the http protocol, the (public) endpoint is a URL beginning with http://. *
*
*
* For the https protocol, the (public) endpoint is a URL beginning with https://. *
*
*
* For the email protocol, the endpoint is an email address. *
*
*
* For the email-json protocol, the endpoint is an email address. *
*
*
* For the sms protocol, the endpoint is a phone number of an SMS-enabled device. *
*
*
* For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue. *
*
*
* For the application protocol, the endpoint is the EndpointArn of a mobile app and device. *
*
*
* For the lambda protocol, the endpoint is the ARN of an Lambda function. *
*
*
* For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery * stream. *
*

*
* For the http protocol, the (public) endpoint is a URL beginning with http://. *
*
*
* For the https protocol, the (public) endpoint is a URL beginning with https://. *
*
*
* For the email protocol, the endpoint is an email address. *
*
*
* For the email-json protocol, the endpoint is an email address. *
*
*
* For the sms protocol, the endpoint is a phone number of an SMS-enabled device. *
*
*
* For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue. *
*
*
* For the application protocol, the endpoint is the EndpointArn of a mobile app and device. *
*
*
* For the lambda protocol, the endpoint is the ARN of an Lambda function. *
*
*
* For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose * delivery stream. *
*

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

*
* For the http protocol, the (public) endpoint is a URL beginning with http://. *
*
*
* For the https protocol, the (public) endpoint is a URL beginning with https://. *
*
*
* For the email protocol, the endpoint is an email address. *
*
*
* For the email-json protocol, the endpoint is an email address. *
*
*
* For the sms protocol, the endpoint is a phone number of an SMS-enabled device. *
*
*
* For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue. *
*
*
* For the application protocol, the endpoint is the EndpointArn of a mobile app and device. *
*
*
* For the lambda protocol, the endpoint is the ARN of an Lambda function. *
*
*
* For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery * stream. *
*

*
* For the http protocol, the (public) endpoint is a URL beginning with http://. *
*
*
* For the https protocol, the (public) endpoint is a URL beginning with https://. *
*
*
* For the email protocol, the endpoint is an email address. *
*
*
* For the email-json protocol, the endpoint is an email address. *
*
*
* For the sms protocol, the endpoint is a phone number of an SMS-enabled device. *
*
*
* For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue. *
*
*
* For the application protocol, the endpoint is the EndpointArn of a mobile app and device. *
*
*
* For the lambda protocol, the endpoint is the ARN of an Lambda function. *
*
*
* For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose * delivery stream. *
*

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

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

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

attributes) { setAttributes(attributes); return this; } /** * Add a single Attributes entry * * @see SubscribeRequest#withAttributes * @returns a reference to this object so that method calls can be chained together. */ public SubscribeRequest 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 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. *

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

* 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 this.returnSubscriptionArn; } /** *

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

* 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. * @return Returns a reference to this object so that method calls can be chained together. */ public SubscribeRequest withReturnSubscriptionArn(Boolean returnSubscriptionArn) { setReturnSubscriptionArn(returnSubscriptionArn); return this; } /** *

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

* 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 this.returnSubscriptionArn; } /** * 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 (getTopicArn() != null) sb.append("TopicArn: ").append(getTopicArn()).append(","); if (getProtocol() != null) sb.append("Protocol: ").append(getProtocol()).append(","); if (getEndpoint() != null) sb.append("Endpoint: ").append(getEndpoint()).append(","); if (getAttributes() != null) sb.append("Attributes: ").append(getAttributes()).append(","); if (getReturnSubscriptionArn() != null) sb.append("ReturnSubscriptionArn: ").append(getReturnSubscriptionArn()); sb.append("}"); return sb.toString(); } @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; } @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 SubscribeRequest clone() { return (SubscribeRequest) super.clone(); } }