Overview | Package | Class | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.amazonaws.services.sns.model
Class ConfirmSubscriptionRequest

    java.lang.Object
      com.amazonaws.AmazonWebServiceRequest
          com.amazonaws.services.sns.model.ConfirmSubscriptionRequest

    public class ConfirmSubscriptionRequest

extends AmazonWebServiceRequest

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".

See Also:
  `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`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### 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(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` - 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

### 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.

### 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.

### withTopicArn

    public ConfirmSubscriptionRequest withTopicArn(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.

  Parameters:
    `topicArn` - The ARN of the topic for which you wish to confirm a subscription.
  Returns:
    A reference to this updated object so that method calls can be chained together.

### 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.

### 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.

### withToken

    public ConfirmSubscriptionRequest withToken(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.

  Parameters:
    `token` - Short-lived token sent to an endpoint during the Subscribe action.
  Returns:
    A reference to this updated object so that method calls can be chained together.

### getAuthenticateOnUnsubscribe

    public String getAuthenticateOnUnsubscribe()

  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.

  Returns:
    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.

### setAuthenticateOnUnsubscribe

    public void setAuthenticateOnUnsubscribe(String 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.

  Parameters:
    `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.

### withAuthenticateOnUnsubscribe

    public ConfirmSubscriptionRequest withAuthenticateOnUnsubscribe(String 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.

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

  Parameters:
    `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.
  Returns:
    A reference to this updated 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()`

Overview | Package | Class | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.