Class ConfirmSubscriptionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.ConfirmSubscriptionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ConfirmSubscriptionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Input for ConfirmSubscription action.

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
ConfirmSubscriptionRequest()	Default constructor for ConfirmSubscriptionRequest object.
ConfirmSubscriptionRequest(String topicArn, String token)	Constructs a new ConfirmSubscriptionRequest object.
ConfirmSubscriptionRequest(String topicArn, String token, String authenticateOnUnsubscribe)	Constructs a new ConfirmSubscriptionRequest object.

Method Summary

Modifier and Type	Method	Description
ConfirmSubscriptionRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAuthenticateOnUnsubscribe()	Disallows unauthenticated unsubscribes of the subscription.
String	getToken()	Short-lived token sent to an endpoint during the Subscribe action.
String	getTopicArn()	The ARN of the topic for which you wish to confirm a subscription.
int	hashCode()
void	setAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe)	Disallows unauthenticated unsubscribes of the subscription.
void	setToken(String token)	Short-lived token sent to an endpoint during the Subscribe action.
void	setTopicArn(String topicArn)	The ARN of the topic for which you wish to confirm a subscription.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
ConfirmSubscriptionRequest	withAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe)	Disallows unauthenticated unsubscribes of the subscription.
ConfirmSubscriptionRequest	withToken(String token)	Short-lived token sent to an endpoint during the Subscribe action.
ConfirmSubscriptionRequest	withTopicArn(String topicArn)	The ARN of the topic for which you wish to confirm a subscription.

Methods inherited from class AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class Object

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

Constructor Details

ConfirmSubscriptionRequest

public ConfirmSubscriptionRequest()

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

ConfirmSubscriptionRequest

public ConfirmSubscriptionRequest(String topicArn,
 String token)

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

Parameters:

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(String topicArn,
 String token,
 String authenticateOnUnsubscribe)

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

Parameters:

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 requires AWS authentication.

Method Details

setTopicArn

public void setTopicArn(String topicArn)

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

Parameters:

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

getTopicArn

public String getTopicArn()

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

Returns:

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

withTopicArn

public ConfirmSubscriptionRequest withTopicArn(String topicArn)

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

Parameters:

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

Returns:

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

setToken

public void setToken(String token)

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

Parameters:

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

getToken

public String getToken()

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

Returns:

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

withToken

public ConfirmSubscriptionRequest withToken(String token)

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

Parameters:

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

Returns:

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

setAuthenticateOnUnsubscribe

public void setAuthenticateOnUnsubscribe(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 requires AWS authentication.

Parameters:

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 requires AWS authentication.

getAuthenticateOnUnsubscribe

public 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 requires AWS authentication.

Returns:

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 requires AWS authentication.

withAuthenticateOnUnsubscribe

public ConfirmSubscriptionRequest withAuthenticateOnUnsubscribe(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 requires AWS authentication.

Parameters:

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 requires AWS authentication.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

• Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ConfirmSubscriptionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

• Object.clone()