SubscribeRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>, SdkBuilder<SubscribeRequest.Builder,SubscribeRequest>, SdkPojo, SdkRequest.Builder, SnsRequest.Builder

Enclosing class:

SubscribeRequest
```
public static interface SubscribeRequest.Builder
extends SnsRequest.Builder, SdkPojo, CopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`SubscribeRequest.Builder`	`attributes(Map<String,String> attributes)` A map of attributes with their corresponding values.
`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.

Methods inherited from interface software.amazon.awssdk.services.sns.model.SnsRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - topicArn
```
SubscribeRequest.Builder topicArn(String topicArn)
```
    The ARN of the topic you want to subscribe to.
    
    Parameters:
    
    topicArn - The ARN of the topic you want to subscribe to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - protocol
```
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 Amazon Lambda function.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - endpoint
```
SubscribeRequest.Builder endpoint(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 Amazon Lambda function.
    Parameters:
    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 Amazon Lambda function.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attributes
```
SubscribeRequest.Builder attributes(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - returnSubscriptionArn
```
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 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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
SubscribeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
SubscribeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface SubscribeRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.sns.model.SnsRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

topicArn

protocol

endpoint

attributes

returnSubscriptionArn

overrideConfiguration

overrideConfiguration