com.amazonaws.services.sns.model

クラス SubscribeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.SubscribeRequest

すべての実装されたインタフェース:

java.io.Serializable

public class SubscribeRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the Subscribe operation.

The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

関連項目:

AmazonSNS.subscribe(SubscribeRequest), 直列化された形式

コンストラクタの概要

コンストラクタ

コンストラクタと説明
SubscribeRequest() Default constructor for a new SubscribeRequest object.
SubscribeRequest(java.lang.String topicArn, java.lang.String protocol, java.lang.String endpoint) Constructs a new SubscribeRequest object.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
boolean	equals(java.lang.Object obj)
java.lang.String	getEndpoint() The endpoint that you want to receive notifications.
java.lang.String	getProtocol() The protocol you want to use.
java.lang.String	getTopicArn() The ARN of topic you want to subscribe to.
int	hashCode()
void	setEndpoint(java.lang.String endpoint) The endpoint that you want to receive notifications.
void	setProtocol(java.lang.String protocol) The protocol you want to use.
void	setTopicArn(java.lang.String topicArn) The ARN of topic you want to subscribe to.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SubscribeRequest	withEndpoint(java.lang.String endpoint) The endpoint that you want to receive notifications.
SubscribeRequest	withProtocol(java.lang.String protocol) The protocol you want to use.
SubscribeRequest	withTopicArn(java.lang.String topicArn) The ARN of topic you want to subscribe to.

クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

クラスから継承されたメソッド java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

SubscribeRequest

public SubscribeRequest()

Default constructor for a new SubscribeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

SubscribeRequest

public SubscribeRequest(java.lang.String topicArn,
                java.lang.String protocol,
                java.lang.String endpoint)

Constructs a new SubscribeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

パラメータ:

topicArn - The ARN of topic you want to subscribe to.

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

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

メソッドの詳細

getTopicArn

public java.lang.String getTopicArn()

The ARN of topic you want to subscribe to.

戻り値:

The ARN of topic you want to subscribe to.

setTopicArn

public void setTopicArn(java.lang.String topicArn)

The ARN of topic you want to subscribe to.

パラメータ:

topicArn - The ARN of topic you want to subscribe to.

withTopicArn

public SubscribeRequest withTopicArn(java.lang.String topicArn)

The ARN of topic you want to subscribe to.

Returns a reference to this object so that method calls can be chained together.

パラメータ:

topicArn - The ARN of topic you want to subscribe to.

getProtocol

public java.lang.String getProtocol()

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

戻り値:

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

setProtocol

public void setProtocol(java.lang.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

パラメータ:

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

withProtocol

public SubscribeRequest withProtocol(java.lang.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

Returns a reference to this object so that method calls can be chained together.

パラメータ:

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

getEndpoint

public java.lang.String getEndpoint()

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

戻り値:

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

setEndpoint

public void setEndpoint(java.lang.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

パラメータ:

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

withEndpoint

public SubscribeRequest withEndpoint(java.lang.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

Returns a reference to this object so that method calls can be chained together.

パラメータ:

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

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

オーバーライド:

toString クラス内 java.lang.Object

戻り値:

A string representation of this object.

関連項目:

Object.toString()

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 java.lang.Object

equals

public boolean equals(java.lang.Object obj)

オーバーライド:

equals クラス内 java.lang.Object