com.amazonaws.services.sns.model

Class SubscribeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.SubscribeRequest

All Implemented Interfaces:

Serializable

public class SubscribeRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the Subscribe operation.

Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

See Also:

AmazonSNS.subscribe(SubscribeRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getEndpoint() The endpoint that you want to receive notifications.
String	getProtocol() The protocol you want to use.
String	getTopicArn() The ARN of the topic you want to subscribe to.
int	hashCode()
void	setEndpoint(String endpoint) The endpoint that you want to receive notifications.
void	setProtocol(String protocol) The protocol you want to use.
void	setTopicArn(String topicArn) The ARN of the topic you want to subscribe to.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SubscribeRequest	withEndpoint(String endpoint) The endpoint that you want to receive notifications.
SubscribeRequest	withProtocol(String protocol) The protocol you want to use.
SubscribeRequest	withTopicArn(String topicArn) The ARN of the topic you want to subscribe to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SubscribeRequest

public SubscribeRequest()

Default constructor for a new SubscribeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

SubscribeRequest

public SubscribeRequest(String topicArn,
                String protocol,
                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 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.

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

• For the http protocol, the endpoint is an URL beginning with "http://"
• For the https protocol, the 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.

Method Detail

getTopicArn

public 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(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(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 String getProtocol()

The protocol 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.

Returns:

The protocol 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.

setProtocol

public void setProtocol(String protocol)

The protocol 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.

Parameters:

protocol - The protocol 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.

withProtocol

public SubscribeRequest withProtocol(String protocol)

The protocol 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.

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

Parameters:

protocol - The protocol 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.

Returns:

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

getEndpoint

public String getEndpoint()

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

• For the http protocol, the endpoint is an URL beginning with "http://"
• For the https protocol, the 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.

Returns:

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

• For the http protocol, the endpoint is an URL beginning with "http://"
• For the https protocol, the 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.

setEndpoint

public void setEndpoint(String endpoint)

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

• For the http protocol, the endpoint is an URL beginning with "http://"
• For the https protocol, the 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.

Parameters:

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

• For the http protocol, the endpoint is an URL beginning with "http://"
• For the https protocol, the 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.

withEndpoint

public SubscribeRequest withEndpoint(String endpoint)

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

• For the http protocol, the endpoint is an URL beginning with "http://"
• For the https protocol, the 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.

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 endpoint is an URL beginning with "http://"
• For the https protocol, the 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.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object