SubscribeRequest.Builder (AWS SDK for Java

All Superinterfaces:

CopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>, SdkBuilder<SubscribeRequest.Builder,SubscribeRequest>

Enclosing class:

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`SubscribeRequest.Builder`	`endpoint(String endpoint)`	The endpoint that you want to receive notifications.
`SubscribeRequest.Builder`	`protocol(String protocol)`	The protocol you want to use.
`SubscribeRequest.Builder`	`topicArn(String topicArn)`	The ARN of the topic you want to subscribe to.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
apply, 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 AWS 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 AWS 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 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface SubscribeRequest.Builder

Method Summary

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