|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.sns.model.ConfirmSubscriptionRequest
public class ConfirmSubscriptionRequest
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)
Constructor Summary | |
---|---|
ConfirmSubscriptionRequest()
Default constructor for a new 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 | |
---|---|
String |
getAuthenticateOnUnsubscribe()
Indicates that you want to disable unauthenticated unsubsciption 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. |
void |
setAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe)
Indicates that you want to disable unauthenticated unsubsciption 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)
Indicates that you want to disable unauthenticated unsubsciption 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 com.amazonaws.AmazonWebServiceRequest |
---|
copyPrivateRequestParameters, getDelegationToken, setDelegationToken |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ConfirmSubscriptionRequest()
public ConfirmSubscriptionRequest(String topicArn, String token)
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.public ConfirmSubscriptionRequest(String topicArn, String token, String authenticateOnUnsubscribe)
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
- Indicates that you want to disable
unauthenticated unsubsciption of the subscription. If parameter is
present in the request, the request has an AWS signature, and the
value of this parameter is true, only the topic owner and the
subscription owner will be permitted to unsubscribe the endopint, and
the Unsubscribe action will require AWS authentication.Method Detail |
---|
public String getTopicArn()
public void setTopicArn(String topicArn)
topicArn
- The ARN of the topic for which you wish to confirm a subscription.public ConfirmSubscriptionRequest withTopicArn(String topicArn)
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.
public String getToken()
public void setToken(String token)
token
- Short-lived token sent to an endpoint during the Subscribe action.public ConfirmSubscriptionRequest withToken(String token)
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.
public String getAuthenticateOnUnsubscribe()
public void setAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe)
authenticateOnUnsubscribe
- Indicates that you want to disable unauthenticated unsubsciption of
the subscription. If parameter is present in the request, the request
has an AWS signature, and the value of this parameter is true, only
the topic owner and the subscription owner will be permitted to
unsubscribe the endopint, and the Unsubscribe action will require AWS
authentication.public ConfirmSubscriptionRequest withAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe)
Returns a reference to this object so that method calls can be chained together.
authenticateOnUnsubscribe
- Indicates that you want to disable unauthenticated unsubsciption of
the subscription. If parameter is present in the request, the request
has an AWS signature, and the value of this parameter is true, only
the topic owner and the subscription owner will be permitted to
unsubscribe the endopint, and the Unsubscribe action will require AWS
authentication.
public String toString()
toString
in class Object
Object.toString()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |