SubscribeRequest (AWS Java SDK :: Services

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(value="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 and Description

static interface SubscribeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SubscribeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()` Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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()` 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 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 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 Amazon Lambda function.
    Returns:
    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 Amazon Lambda function.
  - endpoint
```
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 Amazon Lambda function.
    Returns:
    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 Amazon Lambda function.
  - hasAttributes
```
public boolean hasAttributes()
```
    Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - attributes
```
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.
    - 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAttributes() to see if a value was sent in this field.
    Returns:
    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.
    
    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.
  - returnSubscriptionArn
```
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 have the subscription ARN returned, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
    - If you don't have the subscription ARN returned, 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.
    If you set this parameter to true, .
    
    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 have the subscription ARN returned, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
    
    If you don't have the subscription ARN returned, 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.
    
    If you set this parameter to true, .
    
    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 int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public 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