CreateTopicRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sns.model.CreateTopicRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class CreateTopicRequest
extends AmazonWebServiceRequest
implements Serializable
```
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`CreateTopicRequest()` Default constructor for CreateTopicRequest object.
`CreateTopicRequest(String name)` Constructs a new CreateTopicRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateTopicRequest`	`addAttributesEntry(String key, String value)` A map of attributes with their corresponding values.
`CreateTopicRequest`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributes()` A map of attributes with their corresponding values.
`String`	`getName()` The name of the topic you want to create.
`List<Tag>`	`getTags()` The list of tags to add to a new topic.
`int`	`hashCode()`
`void`	`setAttributes(Map<String,String> attributes)` A map of attributes with their corresponding values.
`void`	`setName(String name)` The name of the topic you want to create.
`void`	`setTags(Collection<Tag> tags)` The list of tags to add to a new topic.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateTopicRequest`	`withAttributes(Map<String,String> attributes)` A map of attributes with their corresponding values.
`CreateTopicRequest`	`withName(String name)` The name of the topic you want to create.
`CreateTopicRequest`	`withTags(Collection<Tag> tags)` The list of tags to add to a new topic.
`CreateTopicRequest`	`withTags(Tag... tags)` The list of tags to add to a new topic.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateTopicRequest
```
public CreateTopicRequest()
```
    Default constructor for CreateTopicRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
  - CreateTopicRequest
```
public CreateTopicRequest(String name)
```
    Constructs a new CreateTopicRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    
    name -
    The name of the topic you want to create.
    
    Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
- Method Detail
  - getName
```
public String getName()
```
    The name of the topic you want to create.
    
    Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
    
    Returns:
    
    The name of the topic you want to create.
    
    Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
  - setName
```
public void setName(String name)
```
    The name of the topic you want to create.
    
    Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
    
    Parameters:
    
    name -
    The name of the topic you want to create.
    
    Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
  - withName
```
public CreateTopicRequest withName(String name)
```
    The name of the topic you want to create.
    
    Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    name -
    The name of the topic you want to create.
    
    Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
    - DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    - DisplayName – The display name to use for a topic with SMS subscriptions.
    - Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
    The following attribute applies only to server-side-encryption:
    - KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
    Returns:
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
    
    DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    
    DisplayName – The display name to use for a topic with SMS subscriptions.
    
    Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
    
    The following attribute applies only to server-side-encryption:
    
    KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
    - DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    - DisplayName – The display name to use for a topic with SMS subscriptions.
    - Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
    The following attribute applies only to server-side-encryption:
    - KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
    Parameters:
    attributes -
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
    
    DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    
    DisplayName – The display name to use for a topic with SMS subscriptions.
    
    Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
    
    The following attribute applies only to server-side-encryption:
    
    KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
  - withAttributes
```
public CreateTopicRequest withAttributes(Map<String,String> attributes)
```
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
    - DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    - DisplayName – The display name to use for a topic with SMS subscriptions.
    - Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
    The following attribute applies only to server-side-encryption:
    - KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    attributes -
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
    
    DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    
    DisplayName – The display name to use for a topic with SMS subscriptions.
    
    Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
    
    The following attribute applies only to server-side-encryption:
    
    KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addAttributesEntry
```
public CreateTopicRequest addAttributesEntry(String key,
                                             String value)
```
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
    - DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    - DisplayName – The display name to use for a topic with SMS subscriptions.
    - Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
    The following attribute applies only to server-side-encryption:
    - KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
    The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.
    Parameters:
    
    key - The key of the entry to be added into Attributes.
    
    value - The corresponding value of the entry to be added into Attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearAttributesEntries
```
public CreateTopicRequest clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The list of tags to add to a new topic.
    
    To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
    
    Returns:
    
    The list of tags to add to a new topic.
    
    To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The list of tags to add to a new topic.
    
    To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
    
    Parameters:
    
    tags -
    The list of tags to add to a new topic.
    
    To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
  - withTags
```
public CreateTopicRequest withTags(Tag... tags)
```
    The list of tags to add to a new topic.
    
    To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tags -
    The list of tags to add to a new topic.
    
    To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withTags
```
public CreateTopicRequest withTags(Collection<Tag> tags)
```
    The list of tags to add to a new topic.
    
    To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tags -
    The list of tags to add to a new topic.
    
    To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
    
    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

Class CreateTopicRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateTopicRequest

CreateTopicRequest

Method Detail

getName

setName

withName

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

getTags

setTags

withTags

withTags

toString

hashCode

equals