Class SubscribeRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SubscribeRequest.Builder,
SubscribeRequest>
Input for Subscribe action.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA map of attributes with their corresponding values.static SubscribeRequest.Builder
builder()
final String
endpoint()
The endpoint that you want to receive notifications.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final String
protocol()
The protocol that you want to use.final Boolean
Sets whether the response from theSubscribe
request includes the subscription ARN, even if the subscription is not yet confirmed.static Class
<? extends SubscribeRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
topicArn()
The ARN of the topic you want to subscribe to.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
topicArn
The ARN of the topic you want to subscribe to.
- Returns:
- The ARN of the topic you want to subscribe to.
-
protocol
The protocol that 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 Lambda function -
firehose
– delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
- Returns:
- The protocol that 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 Lambda function -
firehose
– delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
-
-
-
endpoint
The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the
http
protocol, the (public) endpoint is a URL beginning withhttp://
. -
For the
https
protocol, the (public) endpoint is a URL beginning withhttps://
. -
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 Lambda function. -
For the
firehose
protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
- Returns:
- The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the
http
protocol, the (public) endpoint is a URL beginning withhttp://
. -
For the
https
protocol, the (public) endpoint is a URL beginning withhttps://
. -
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 Lambda function. -
For the
firehose
protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
-
-
-
hasAttributes
public final boolean hasAttributes()For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
attributes
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
Subscribe
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. -
FilterPolicyScope
– This attribute lets you choose the filtering scope by using one of the following string value types:-
MessageAttributes
(default) – The filter is applied on the message attributes. -
MessageBody
– The filter is applied on the message body.
-
-
RawMessageDelivery
– When set totrue
, 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. -
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
-
SubscriptionRoleArn
– The ARN of the IAM role that has the following:-
Permission to write to the Kinesis Data Firehose delivery stream
-
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
-
The following attributes apply only to FIFO topics:
-
ReplayPolicy
– Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic. -
ReplayStatus
– Retrieves the status of the subscription message replay, which can be one of the following:-
Completed
– The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in theReplayPolicy
then the subscription will no longer receive newly published messages. -
In progress
– The replay is currently replaying the selected messages. -
Failed
– The replay was unable to complete. -
Pending
– The default state while the replay initiates.
-
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttributes()
method.- Returns:
- A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
Subscribe
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. -
FilterPolicyScope
– This attribute lets you choose the filtering scope by using one of the following string value types:-
MessageAttributes
(default) – The filter is applied on the message attributes. -
MessageBody
– The filter is applied on the message body.
-
-
RawMessageDelivery
– When set totrue
, 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. -
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
-
SubscriptionRoleArn
– The ARN of the IAM role that has the following:-
Permission to write to the Kinesis Data Firehose delivery stream
-
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
-
The following attributes apply only to FIFO topics:
-
ReplayPolicy
– Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic. -
ReplayStatus
– Retrieves the status of the subscription message replay, which can be one of the following:-
Completed
– The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in theReplayPolicy
then the subscription will no longer receive newly published messages. -
In progress
– The replay is currently replaying the selected messages. -
Failed
– The replay was unable to complete. -
Pending
– The default state while the replay initiates.
-
-
-
-
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
true
, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes thepending subscription
ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls theConfirmSubscription
action with a confirmation token.The default value is
false
.- Returns:
- 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
true
, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes thepending subscription
ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls theConfirmSubscription
action with a confirmation token.The default value is
false
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SubscribeRequest.Builder,
SubscribeRequest> - Specified by:
toBuilder
in classSnsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-