Package com.amazonaws.services.sns.model
Class SubscribeRequest
java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.sns.model.SubscribeRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Input for Subscribe action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for SubscribeRequest object.SubscribeRequest
(String topicArn, String protocol, String endpoint) Constructs a new SubscribeRequest object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The endpoint that you want to receive notifications.The protocol you want to use.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.toString()
Returns a string representation of this object; useful for testing and debugging.withEndpoint
(String endpoint) The endpoint that you want to receive notifications.withProtocol
(String protocol) The protocol you want to use.withTopicArn
(String topicArn) The ARN of the topic you want to subscribe to.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
SubscribeRequest
public SubscribeRequest()Default constructor for SubscribeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
SubscribeRequest
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.
- For the
-
-
Method Details
-
setTopicArn
The ARN of the topic you want to subscribe to.
- Parameters:
topicArn
- The ARN of the topic you want to subscribe to.
-
getTopicArn
The ARN of the topic you want to subscribe to.
- Returns:
- The ARN of the topic you want to subscribe to.
-
withTopicArn
The ARN of the topic you want to subscribe to.
- Parameters:
topicArn
- The ARN of the topic you want to subscribe to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setProtocol
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.
-
-
-
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.
-
-
-
withProtocol
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setEndpoint
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.
- For the
- For the
-
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.
- For the
- For the
-
withEndpoint
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.
- For the
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- For the
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-