com.amazonaws.services.sns.model

クラス ConfirmSubscriptionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.ConfirmSubscriptionRequest

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

java.io.Serializable

public class ConfirmSubscriptionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the ConfirmSubscription operation.

The ConfirmSubscription action verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

関連項目:

AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest), 直列化された形式

コンストラクタの概要

コンストラクタ

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

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
boolean	equals(java.lang.Object obj)
java.lang.String	getAuthenticateOnUnsubscribe() Disallows unauthenticated unsubscribes of the subscription.
java.lang.String	getToken() Short-lived token sent to an endpoint during the Subscribe action.
java.lang.String	getTopicArn() The ARN of the topic for which you wish to confirm a subscription.
int	hashCode()
void	setAuthenticateOnUnsubscribe(java.lang.String authenticateOnUnsubscribe) Disallows unauthenticated unsubscribes of the subscription.
void	setToken(java.lang.String token) Short-lived token sent to an endpoint during the Subscribe action.
void	setTopicArn(java.lang.String topicArn) The ARN of the topic for which you wish to confirm a subscription.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ConfirmSubscriptionRequest	withAuthenticateOnUnsubscribe(java.lang.String authenticateOnUnsubscribe) Disallows unauthenticated unsubscribes of the subscription.
ConfirmSubscriptionRequest	withToken(java.lang.String token) Short-lived token sent to an endpoint during the Subscribe action.
ConfirmSubscriptionRequest	withTopicArn(java.lang.String topicArn) The ARN of the topic for which you wish to confirm a subscription.

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

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

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

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

コンストラクタの詳細

ConfirmSubscriptionRequest

public ConfirmSubscriptionRequest()

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

ConfirmSubscriptionRequest

public ConfirmSubscriptionRequest(java.lang.String topicArn,
                          java.lang.String token)

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

パラメータ:

topicArn - The ARN of the topic for which you wish to confirm a subscription.

token - Short-lived token sent to an endpoint during the Subscribe action.

ConfirmSubscriptionRequest

public ConfirmSubscriptionRequest(java.lang.String topicArn,
                          java.lang.String token,
                          java.lang.String authenticateOnUnsubscribe)

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

パラメータ:

topicArn - The ARN of the topic for which you wish to confirm a subscription.

token - Short-lived token sent to an endpoint during the Subscribe action.

authenticateOnUnsubscribe - Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action will require AWS authentication.

メソッドの詳細

getTopicArn

public java.lang.String getTopicArn()

The ARN of the topic for which you wish to confirm a subscription.

戻り値:

The ARN of the topic for which you wish to confirm a subscription.

setTopicArn

public void setTopicArn(java.lang.String topicArn)

The ARN of the topic for which you wish to confirm a subscription.

パラメータ:

topicArn - The ARN of the topic for which you wish to confirm a subscription.

withTopicArn

public ConfirmSubscriptionRequest withTopicArn(java.lang.String topicArn)

The ARN of the topic for which you wish to confirm a subscription.

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

パラメータ:

topicArn - The ARN of the topic for which you wish to confirm a subscription.

getToken

public java.lang.String getToken()

Short-lived token sent to an endpoint during the Subscribe action.

戻り値:

Short-lived token sent to an endpoint during the Subscribe action.

setToken

public void setToken(java.lang.String token)

Short-lived token sent to an endpoint during the Subscribe action.

パラメータ:

token - Short-lived token sent to an endpoint during the Subscribe action.

withToken

public ConfirmSubscriptionRequest withToken(java.lang.String token)

Short-lived token sent to an endpoint during the Subscribe action.

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

パラメータ:

token - Short-lived token sent to an endpoint during the Subscribe action.

getAuthenticateOnUnsubscribe

public java.lang.String getAuthenticateOnUnsubscribe()

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action will require AWS authentication.

戻り値:

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action will require AWS authentication.

setAuthenticateOnUnsubscribe

public void setAuthenticateOnUnsubscribe(java.lang.String authenticateOnUnsubscribe)

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action will require AWS authentication.

パラメータ:

authenticateOnUnsubscribe - Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action will require AWS authentication.

withAuthenticateOnUnsubscribe

public ConfirmSubscriptionRequest withAuthenticateOnUnsubscribe(java.lang.String authenticateOnUnsubscribe)

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action will require AWS authentication.

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

パラメータ:

authenticateOnUnsubscribe - Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action will require AWS authentication.

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