public class ConfirmSubscriptionRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
ConfirmSubscription operation
.
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".
NOOP
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
ConfirmSubscriptionRequest |
clone() |
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.
|
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
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
- 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.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()
Subscribe
action.Subscribe
action.public void setToken(String token)
Subscribe
action.token
- Short-lived token sent to an endpoint during the
Subscribe
action.public ConfirmSubscriptionRequest withToken(String token)
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.public String getAuthenticateOnUnsubscribe()
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.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.public void setAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe)
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.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.public ConfirmSubscriptionRequest withAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe)
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 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 requires AWS
authentication.public String toString()
toString
in class Object
Object.toString()
public ConfirmSubscriptionRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2015. All rights reserved.