@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SubscribeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Input for Subscribe action.
NOOP
Constructor and Description |
---|
SubscribeRequest()
Default constructor for SubscribeRequest object.
|
SubscribeRequest(String topicArn,
String protocol,
String endpoint)
Constructs a new SubscribeRequest object.
|
Modifier and Type | Method and Description |
---|---|
SubscribeRequest |
addAttributesEntry(String key,
String value) |
SubscribeRequest |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
SubscribeRequest |
clone() |
boolean |
equals(Object obj) |
Map<String,String> |
getAttributes()
Assigns attributes to the subscription as a map of key-value pairs.
|
String |
getEndpoint()
The endpoint that you want to receive notifications.
|
String |
getProtocol()
The protocol you want to use.
|
Boolean |
getReturnSubscriptionArn()
Sets whether the response from the
Subscribe request includes the subscription ARN, even if the
subscription is not yet confirmed. |
String |
getTopicArn()
The ARN of the topic you want to subscribe to.
|
int |
hashCode() |
Boolean |
isReturnSubscriptionArn()
Sets whether the response from the
Subscribe request includes the subscription ARN, even if the
subscription is not yet confirmed. |
void |
setAttributes(Map<String,String> attributes)
Assigns attributes to the subscription as a map of key-value pairs.
|
void |
setEndpoint(String endpoint)
The endpoint that you want to receive notifications.
|
void |
setProtocol(String protocol)
The protocol you want to use.
|
void |
setReturnSubscriptionArn(Boolean returnSubscriptionArn)
Sets whether the response from the
Subscribe request includes the subscription ARN, even if the
subscription is not yet confirmed. |
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 |
withAttributes(Map<String,String> attributes)
Assigns attributes to the subscription as a map of key-value pairs.
|
SubscribeRequest |
withEndpoint(String endpoint)
The endpoint that you want to receive notifications.
|
SubscribeRequest |
withProtocol(String protocol)
The protocol you want to use.
|
SubscribeRequest |
withReturnSubscriptionArn(Boolean returnSubscriptionArn)
Sets whether the response from the
Subscribe request includes the subscription ARN, even if the
subscription is not yet confirmed. |
SubscribeRequest |
withTopicArn(String topicArn)
The ARN of the topic you want to subscribe to.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public SubscribeRequest()
public SubscribeRequest(String topicArn, String protocol, String endpoint)
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.
lambda
-- delivery of JSON-encoded message to an AWS Lambda function.
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 lambda
protocol, the endpoint is the ARN of an AWS Lambda function.
public void setTopicArn(String topicArn)
The ARN of the topic you want to subscribe to.
topicArn
- The ARN of the topic you want to subscribe to.public String getTopicArn()
The ARN of the topic you want to subscribe to.
public SubscribeRequest withTopicArn(String topicArn)
The ARN of the topic you want to subscribe to.
topicArn
- The ARN of the topic you want to subscribe to.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.
lambda
-- delivery of JSON-encoded message to an AWS Lambda function.
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.
lambda
-- delivery of JSON-encoded message to an AWS Lambda function.
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.
lambda
-- delivery of JSON-encoded message to an AWS Lambda function.
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.
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.
lambda
-- delivery of JSON-encoded message to an AWS Lambda function.
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.
lambda
-- delivery of JSON-encoded message to an AWS Lambda function.
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.
For the lambda
protocol, the endpoint is the ARN of an AWS Lambda function.
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 lambda
protocol, the endpoint is the ARN of an AWS Lambda function.
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.
For the lambda
protocol, the endpoint is the ARN of an AWS Lambda function.
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 lambda
protocol, the endpoint is the ARN of an AWS Lambda function.
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.
For the lambda
protocol, the endpoint is the ARN of an AWS Lambda function.
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 lambda
protocol, the endpoint is the ARN of an AWS Lambda function.
public Map<String,String> getAttributes()
Assigns attributes to the subscription as a map of key-value pairs. You can assign any attribute that is
supported by the SetSubscriptionAttributes
action.
SetSubscriptionAttributes
action.public void setAttributes(Map<String,String> attributes)
Assigns attributes to the subscription as a map of key-value pairs. You can assign any attribute that is
supported by the SetSubscriptionAttributes
action.
attributes
- Assigns attributes to the subscription as a map of key-value pairs. You can assign any attribute that is
supported by the SetSubscriptionAttributes
action.public SubscribeRequest withAttributes(Map<String,String> attributes)
Assigns attributes to the subscription as a map of key-value pairs. You can assign any attribute that is
supported by the SetSubscriptionAttributes
action.
attributes
- Assigns attributes to the subscription as a map of key-value pairs. You can assign any attribute that is
supported by the SetSubscriptionAttributes
action.public SubscribeRequest addAttributesEntry(String key, String value)
public SubscribeRequest clearAttributesEntries()
public void setReturnSubscriptionArn(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 false
, the response includes the ARN for confirmed subscriptions, but
it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription
becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation
token.
If you set this parameter to true
, the response includes the ARN in all cases, even if the
subscription is not yet confirmed.
The default value is false
.
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 false
, the response includes the ARN for confirmed
subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet
confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation token.
If you set this parameter to true
, the response includes the ARN in all cases, even if the
subscription is not yet confirmed.
The default value is false
.
public 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 false
, the response includes the ARN for confirmed subscriptions, but
it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription
becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation
token.
If you set this parameter to true
, the response includes the ARN in all cases, even if the
subscription is not yet confirmed.
The default value is false
.
Subscribe
request includes the subscription ARN, even if
the subscription is not yet confirmed.
If you set this parameter to false
, the response includes the ARN for confirmed
subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet
confirmed. A subscription becomes confirmed when the subscriber calls the
ConfirmSubscription
action with a confirmation token.
If you set this parameter to true
, the response includes the ARN in all cases, even if the
subscription is not yet confirmed.
The default value is false
.
public SubscribeRequest withReturnSubscriptionArn(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 false
, the response includes the ARN for confirmed subscriptions, but
it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription
becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation
token.
If you set this parameter to true
, the response includes the ARN in all cases, even if the
subscription is not yet confirmed.
The default value is false
.
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 false
, the response includes the ARN for confirmed
subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet
confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation token.
If you set this parameter to true
, the response includes the ARN in all cases, even if the
subscription is not yet confirmed.
The default value is false
.
public 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 false
, the response includes the ARN for confirmed subscriptions, but
it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription
becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation
token.
If you set this parameter to true
, the response includes the ARN in all cases, even if the
subscription is not yet confirmed.
The default value is false
.
Subscribe
request includes the subscription ARN, even if
the subscription is not yet confirmed.
If you set this parameter to false
, the response includes the ARN for confirmed
subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet
confirmed. A subscription becomes confirmed when the subscriber calls the
ConfirmSubscription
action with a confirmation token.
If you set this parameter to true
, the response includes the ARN in all cases, even if the
subscription is not yet confirmed.
The default value is false
.
public String toString()
toString
in class Object
Object.toString()
public SubscribeRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2018. All rights reserved.