public static interface SubscribeRequest.Builder extends SnsRequest.Builder, CopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>
Modifier and Type | Method and Description |
---|---|
SubscribeRequest.Builder |
attributes(Map<String,String> attributes)
Assigns attributes to the subscription as a map of key-value pairs.
|
SubscribeRequest.Builder |
endpoint(String endpoint)
The endpoint that you want to receive notifications.
|
SubscribeRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
SubscribeRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
SubscribeRequest.Builder |
protocol(String protocol)
The protocol you want to use.
|
SubscribeRequest.Builder |
returnSubscriptionArn(Boolean returnSubscriptionArn)
Sets whether the response from the
Subscribe request includes the subscription ARN, even if the
subscription is not yet confirmed. |
SubscribeRequest.Builder |
topicArn(String topicArn)
The ARN of the topic you want to subscribe to.
|
build
overrideConfiguration
copy
applyMutation, build
SubscribeRequest.Builder topicArn(String topicArn)
The ARN of the topic you want to subscribe to.
topicArn
- The ARN of the topic you want to subscribe to.SubscribeRequest.Builder protocol(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.
SubscribeRequest.Builder endpoint(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.
SubscribeRequest.Builder attributes(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.SubscribeRequest.Builder returnSubscriptionArn(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
.
SubscribeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
SubscribeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2018. All rights reserved.