@Generated(value="software.amazon.awssdk:codegen") public class SubscribeRequest extends SNSRequest implements ToCopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>
Input for Subscribe action.
Modifier and Type | Class and Description |
---|---|
static interface |
SubscribeRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static SubscribeRequest.Builder |
builder() |
String |
endpoint()
The endpoint that you want to receive notifications.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
protocol()
The protocol you want to use.
|
static Class<? extends SubscribeRequest.Builder> |
serializableBuilderClass() |
SubscribeRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
topicArn()
The ARN of the topic you want to subscribe to.
|
String |
toString() |
requestOverrideConfig
copy
public String topicArn()
The ARN of the topic you want to subscribe to.
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 AWS Lambda function.
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.
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 AWS Lambda function.
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.
public SubscribeRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>
toBuilder
in class SNSRequest
public static SubscribeRequest.Builder builder()
public static Class<? extends SubscribeRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.