java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.sns.model.SnsRequest
    - - software.amazon.awssdk.services.sns.model.SubscribeRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SubscribeRequest
extends SnsRequest
implements ToCopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>

Input for Subscribe action.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SubscribeRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()`	For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`String`	`protocol()`	The protocol that 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()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - topicArn
```
public final String topicArn()
```
    The ARN of the topic you want to subscribe to.
    
    Returns:
    
    The ARN of the topic you want to subscribe to.
  - protocol
```
public final String 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
```
public final String endpoint()
```
    The endpoint that you want to receive notifications. Endpoints vary by protocol:
    
    For the http protocol, the (public) endpoint is a URL beginning with http://.
    
    For the https protocol, the (public) 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 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 with http://.
    
    For the https protocol, the (public) 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 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 the isEmpty() 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
```
public final 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 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 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.
    
    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 the ReplayPolicy 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 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.
    
    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 the ReplayPolicy 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
```
public final 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 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 the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription 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 the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
    
    The default value is false.
  - toBuilder
```
public SubscribeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>
    
    Specified by:
    
    toBuilder in class SnsRequest
  - builder
```
public static SubscribeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SubscribeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SubscribeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

topicArn

protocol

endpoint

hasAttributes

attributes

returnSubscriptionArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields