Package software.amazon.awssdk.services.sns.model

Class SubscribeRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.sns.model.SubscribeRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>

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

Input for Subscribe action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SubscribeRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static SubscribeRequest.Builder	builder()
String	endpoint()	The endpoint that you want to receive notifications.
boolean	equals(Object obj)
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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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 AWS 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 AWS 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 AWS 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 AWS Lambda function.

toBuilder

public SubscribeRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SubscribeRequest.Builder,SubscribeRequest>

Returns:

a builder for type T

builder

public static SubscribeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SubscribeRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object