com.amazonaws.services.sns.model

Class SubscribeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.SubscribeRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SubscribeRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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 AWS 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).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SubscribeRequest() Default constructor for SubscribeRequest object.
SubscribeRequest(java.lang.String topicArn, java.lang.String protocol, java.lang.String endpoint) Constructs a new SubscribeRequest object.

Method Summary

Modifier and Type	Method and Description
SubscribeRequest	addAttributesEntry(java.lang.String key, java.lang.String value) A map of attributes with their corresponding values.
SubscribeRequest	clearAttributesEntries() Removes all the entries added into Attributes.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getAttributes() A map of attributes with their corresponding values.
java.lang.String	getEndpoint() The endpoint that you want to receive notifications.
java.lang.String	getProtocol() The protocol that you want to use.
java.lang.Boolean	getReturnSubscriptionArn() Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
java.lang.String	getTopicArn() The ARN of the topic you want to subscribe to.
int	hashCode()
java.lang.Boolean	isReturnSubscriptionArn() Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) A map of attributes with their corresponding values.
void	setEndpoint(java.lang.String endpoint) The endpoint that you want to receive notifications.
void	setProtocol(java.lang.String protocol) The protocol that you want to use.
void	setReturnSubscriptionArn(java.lang.Boolean returnSubscriptionArn) Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
void	setTopicArn(java.lang.String topicArn) The ARN of the topic you want to subscribe to.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SubscribeRequest	withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) A map of attributes with their corresponding values.
SubscribeRequest	withEndpoint(java.lang.String endpoint) The endpoint that you want to receive notifications.
SubscribeRequest	withProtocol(java.lang.String protocol) The protocol that you want to use.
SubscribeRequest	withReturnSubscriptionArn(java.lang.Boolean returnSubscriptionArn) Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
SubscribeRequest	withTopicArn(java.lang.String topicArn) The ARN of the topic you want to subscribe to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SubscribeRequest

public SubscribeRequest()

Default constructor for SubscribeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

SubscribeRequest

public SubscribeRequest(java.lang.String topicArn,
                        java.lang.String protocol,
                        java.lang.String endpoint)

Constructs a new SubscribeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

topicArn -

The ARN of the topic you want to subscribe to.

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 AWS Lambda function

• firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

endpoint -

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 AWS Lambda function.

• For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Method Detail

getTopicArn

public java.lang.String getTopicArn()

The ARN of the topic you want to subscribe to.

Returns:

The ARN of the topic you want to subscribe to.

setTopicArn

public void setTopicArn(java.lang.String topicArn)

The ARN of the topic you want to subscribe to.

Parameters:

topicArn -

The ARN of the topic you want to subscribe to.

withTopicArn

public SubscribeRequest withTopicArn(java.lang.String 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.

Parameters:

topicArn -

The ARN of the topic you want to subscribe to.

Returns:

A reference to this updated object so that method calls can be chained together.

getProtocol

public java.lang.String getProtocol()

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 AWS Lambda function

• firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Returns:

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 AWS Lambda function

• firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

setProtocol

public void setProtocol(java.lang.String 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 AWS Lambda function

• firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Parameters:

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 AWS Lambda function

• firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

withProtocol

public SubscribeRequest withProtocol(java.lang.String 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 AWS Lambda function

• firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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 AWS Lambda function

• firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Returns:

A reference to this updated object so that method calls can be chained together.

getEndpoint

public java.lang.String getEndpoint()

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 AWS Lambda function.

• For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Returns:

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 AWS Lambda function.

• For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

setEndpoint

public void setEndpoint(java.lang.String endpoint)

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 AWS Lambda function.

• For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Parameters:

endpoint -

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 AWS Lambda function.

• For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

withEndpoint

public SubscribeRequest withEndpoint(java.lang.String endpoint)

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 AWS Lambda function.

• For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Returns a reference to this object so that method calls can be chained together.

Parameters:

endpoint -

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 AWS Lambda function.

• For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Returns:

A reference to this updated object so that method calls can be chained together.

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes 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.

• 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 map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes 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.

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

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes 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.

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

Parameters:

attributes -

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes 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.

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

withAttributes

public SubscribeRequest withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes 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.

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

Parameters:

attributes -

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes 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.

• 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 updated object so that method calls can be chained together.

addAttributesEntry

public SubscribeRequest addAttributesEntry(java.lang.String key,
                                           java.lang.String value)

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes 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.

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

Parameters:

key - The key of the entry to be added into Attributes.

value - The corresponding value of the entry to be added into Attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

clearAttributesEntries

public SubscribeRequest clearAttributesEntries()

Removes all the entries added into Attributes.

Returns a reference to this object so that method calls can be chained together.

isReturnSubscriptionArn

public java.lang.Boolean isReturnSubscriptionArn()

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:

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.

getReturnSubscriptionArn

public java.lang.Boolean getReturnSubscriptionArn()

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:

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.

setReturnSubscriptionArn

public void setReturnSubscriptionArn(java.lang.Boolean 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.

Parameters:

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.

withReturnSubscriptionArn

public SubscribeRequest withReturnSubscriptionArn(java.lang.Boolean 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.

Parameters:

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 updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object