com.amazonaws.services.sns.model.CreateTopicRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sns Show documentation
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.sns.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Input for CreateTopic action.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateTopicRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*
* For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
*
*/
private String name;
/**
*
* 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.
*
*
* -
*
* FifoTopic – Set to true to create a FIFO topic.
*
*
* -
*
* 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 Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and
* this attribute is false, you must specify a value for the MessageDeduplicationId
* parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to
* generate the MessageDeduplicationId using the body of the message (but not the attributes of the
* message).
*
*
* (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
* parameter for the Publish action.
*
*
*
*
*
*/
private com.amazonaws.internal.SdkInternalMap attributes;
/**
*
* 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.
*
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
* Default constructor for CreateTopicRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize the object after creating it.
*/
public CreateTopicRequest() {
}
/**
* Constructs a new CreateTopicRequest object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param 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.
*
*
* For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
*/
public CreateTopicRequest(String name) {
setName(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.
*
*
* For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
*
*
* @param 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.
*
*
* For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
*/
public void setName(String name) {
this.name = 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.
*
*
* For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
*
*
* @return 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.
*
*
* For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
*/
public String getName() {
return this.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.
*
*
* For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
*
*
* @param 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.
*
*
* For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTopicRequest withName(String name) {
setName(name);
return this;
}
/**
*
* 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.
*
*
* -
*
* FifoTopic – Set to true to create a FIFO topic.
*
*
* -
*
* 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 Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and
* this attribute is false, you must specify a value for the MessageDeduplicationId
* parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to
* generate the MessageDeduplicationId using the body of the message (but not the attributes of the
* message).
*
*
* (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
* parameter for the Publish action.
*
*
*
*
*
*
* @return 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.
*
*
* -
*
* FifoTopic – Set to true to create a FIFO topic.
*
*
* -
*
* 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 Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO
* topic and this attribute is false, you must specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash
* to generate the MessageDeduplicationId using the body of the message (but not the attributes
* of the message).
*
*
* (Optional) To override the generated value, you can specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
*
*
*/
public java.util.Map getAttributes() {
if (attributes == null) {
attributes = new com.amazonaws.internal.SdkInternalMap();
}
return 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.
*
*
* -
*
* FifoTopic – Set to true to create a FIFO topic.
*
*
* -
*
* 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 Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and
* this attribute is false, you must specify a value for the MessageDeduplicationId
* parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to
* generate the MessageDeduplicationId using the body of the message (but not the attributes of the
* message).
*
*
* (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
* parameter for the Publish action.
*
*
*
*
*
*
* @param 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.
*
*
* -
*
* FifoTopic – Set to true to create a FIFO topic.
*
*
* -
*
* 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 Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO
* topic and this attribute is false, you must specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash
* to generate the MessageDeduplicationId using the body of the message (but not the attributes
* of the message).
*
*
* (Optional) To override the generated value, you can specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
*
*
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = attributes == null ? null : new com.amazonaws.internal.SdkInternalMap(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.
*
*
* -
*
* FifoTopic – Set to true to create a FIFO topic.
*
*
* -
*
* 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 Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and
* this attribute is false, you must specify a value for the MessageDeduplicationId
* parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to
* generate the MessageDeduplicationId using the body of the message (but not the attributes of the
* message).
*
*
* (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
* parameter for the Publish action.
*
*
*
*
*
*
* @param 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.
*
*
* -
*
* FifoTopic – Set to true to create a FIFO topic.
*
*
* -
*
* 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 Amazon Web Services 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 Key Management Service API Reference.
*
*
*
*
* The following attributes apply only to FIFO topics:
*
*
* -
*
* FifoTopic – When this is set to true, a FIFO topic is created.
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
*
*
* -
*
* By default, ContentBasedDeduplication is set to false. If you create a FIFO
* topic and this attribute is false, you must specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
* -
*
* When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash
* to generate the MessageDeduplicationId using the body of the message (but not the attributes
* of the message).
*
*
* (Optional) To override the generated value, you can specify a value for the
* MessageDeduplicationId parameter for the Publish action.
*
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTopicRequest withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* Add a single Attributes entry
*
* @see CreateTopicRequest#withAttributes
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateTopicRequest addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new com.amazonaws.internal.SdkInternalMap();
}
if (this.attributes.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.attributes.put(key, value);
return this;
}
/**
* Removes all the entries added into Attributes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTopicRequest clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
*
* 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.
*
*
*
* @return 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.
*
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
*
* @param 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.
*
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(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.
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTopicRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTopicRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateTopicRequest == false)
return false;
CreateTopicRequest other = (CreateTopicRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateTopicRequest clone() {
return (CreateTopicRequest) super.clone();
}
}