com.amazonaws.services.sns.model
Class DeleteTopicRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.sns.model.DeleteTopicRequest

public class DeleteTopicRequest
extends AmazonWebServiceRequest

Container for the parameters to the DeleteTopic operation.

The DeleteTopic action deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist will not result in an error.

See Also:
AmazonSNS.deleteTopic(DeleteTopicRequest)

Constructor Summary
DeleteTopicRequest()
          Default constructor for a new DeleteTopicRequest object.
DeleteTopicRequest(String topicArn)
          Constructs a new DeleteTopicRequest object.
 
Method Summary
 boolean equals(Object obj)
           
 String getTopicArn()
          The ARN of the topic you want to delete.
 int hashCode()
           
 void setTopicArn(String topicArn)
          The ARN of the topic you want to delete.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 DeleteTopicRequest withTopicArn(String topicArn)
          The ARN of the topic you want to delete.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DeleteTopicRequest

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


DeleteTopicRequest

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

Parameters:
topicArn - The ARN of the topic you want to delete. http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D fba800b9-3765-11df-8cf3-c58c53254dfb
Method Detail

getTopicArn

public String getTopicArn()
The ARN of the topic you want to delete. http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D fba800b9-3765-11df-8cf3-c58c53254dfb

Returns:
The ARN of the topic you want to delete. http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D fba800b9-3765-11df-8cf3-c58c53254dfb

setTopicArn

public void setTopicArn(String topicArn)
The ARN of the topic you want to delete. http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D fba800b9-3765-11df-8cf3-c58c53254dfb

Parameters:
topicArn - The ARN of the topic you want to delete. http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D fba800b9-3765-11df-8cf3-c58c53254dfb

withTopicArn

public DeleteTopicRequest withTopicArn(String topicArn)
The ARN of the topic you want to delete. http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D fba800b9-3765-11df-8cf3-c58c53254dfb

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

Parameters:
topicArn - The ARN of the topic you want to delete. http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D fba800b9-3765-11df-8cf3-c58c53254dfb
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()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object


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