@Generated(value="software.amazon.awssdk:codegen") public final class SubscribeRequest extends SnsRequest implements ToCopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>
Input for Subscribe action.
Modifier and Type | Class and Description |
---|---|
static interface |
SubscribeRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Map<String,String> |
attributes()
A map of attributes with their corresponding values.
|
static SubscribeRequest.Builder |
builder() |
String |
endpoint()
The endpoint that you want to receive notifications.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
protocol()
The protocol you want to use.
|
Boolean |
returnSubscriptionArn()
Sets whether the response from the
Subscribe request includes the subscription ARN, even if the
subscription is not yet confirmed. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends SubscribeRequest.Builder> |
serializableBuilderClass() |
SubscribeRequest.Builder |
toBuilder() |
String |
topicArn()
The ARN of the topic you want to subscribe to.
|
String |
toString() |
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public String topicArn()
The ARN of the topic you want to subscribe to.
public 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.
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 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.
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> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public 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
.
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.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>
toBuilder
in class SnsRequest
public static SubscribeRequest.Builder builder()
public static Class<? extends SubscribeRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2018. All rights reserved.