com.amazonaws.services.sns.model.SetTopicAttributesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sns Show documentation
/*
* Copyright 2014-2019 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 SetTopicAttributes action.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SetTopicAttributesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ARN of the topic to modify.
*
*/
private String topicArn;
/**
*
* A map of attributes with their corresponding values.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetTopicAttributes 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.
*
*
*
*/
private String attributeName;
/**
*
* The new value for the attribute.
*
*/
private String attributeValue;
/**
* Default constructor for SetTopicAttributesRequest object. Callers should use the setter or fluent setter
* (with...) methods to initialize the object after creating it.
*/
public SetTopicAttributesRequest() {
}
/**
* Constructs a new SetTopicAttributesRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param topicArn
* The ARN of the topic to modify.
* @param attributeName
* A map of attributes with their corresponding values.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetTopicAttributes 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.
*
*
* @param attributeValue
* The new value for the attribute.
*/
public SetTopicAttributesRequest(String topicArn, String attributeName, String attributeValue) {
setTopicArn(topicArn);
setAttributeName(attributeName);
setAttributeValue(attributeValue);
}
/**
*
* The ARN of the topic to modify.
*
*
* @param topicArn
* The ARN of the topic to modify.
*/
public void setTopicArn(String topicArn) {
this.topicArn = topicArn;
}
/**
*
* The ARN of the topic to modify.
*
*
* @return The ARN of the topic to modify.
*/
public String getTopicArn() {
return this.topicArn;
}
/**
*
* The ARN of the topic to modify.
*
*
* @param topicArn
* The ARN of the topic to modify.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SetTopicAttributesRequest withTopicArn(String topicArn) {
setTopicArn(topicArn);
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
* SetTopicAttributes 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.
*
*
*
*
* @param attributeName
* A map of attributes with their corresponding values.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetTopicAttributes 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.
*
*
*/
public void setAttributeName(String attributeName) {
this.attributeName = attributeName;
}
/**
*
* A map of attributes with their corresponding values.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetTopicAttributes 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.
*
*
*
*
* @return A map of attributes with their corresponding values.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetTopicAttributes 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.
*
*
*/
public String getAttributeName() {
return this.attributeName;
}
/**
*
* A map of attributes with their corresponding values.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetTopicAttributes 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.
*
*
*
*
* @param attributeName
* A map of attributes with their corresponding values.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetTopicAttributes 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SetTopicAttributesRequest withAttributeName(String attributeName) {
setAttributeName(attributeName);
return this;
}
/**
*
* The new value for the attribute.
*
*
* @param attributeValue
* The new value for the attribute.
*/
public void setAttributeValue(String attributeValue) {
this.attributeValue = attributeValue;
}
/**
*
* The new value for the attribute.
*
*
* @return The new value for the attribute.
*/
public String getAttributeValue() {
return this.attributeValue;
}
/**
*
* The new value for the attribute.
*
*
* @param attributeValue
* The new value for the attribute.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SetTopicAttributesRequest withAttributeValue(String attributeValue) {
setAttributeValue(attributeValue);
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 (getTopicArn() != null)
sb.append("TopicArn: ").append(getTopicArn()).append(",");
if (getAttributeName() != null)
sb.append("AttributeName: ").append(getAttributeName()).append(",");
if (getAttributeValue() != null)
sb.append("AttributeValue: ").append(getAttributeValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SetTopicAttributesRequest == false)
return false;
SetTopicAttributesRequest other = (SetTopicAttributesRequest) obj;
if (other.getTopicArn() == null ^ this.getTopicArn() == null)
return false;
if (other.getTopicArn() != null && other.getTopicArn().equals(this.getTopicArn()) == false)
return false;
if (other.getAttributeName() == null ^ this.getAttributeName() == null)
return false;
if (other.getAttributeName() != null && other.getAttributeName().equals(this.getAttributeName()) == false)
return false;
if (other.getAttributeValue() == null ^ this.getAttributeValue() == null)
return false;
if (other.getAttributeValue() != null && other.getAttributeValue().equals(this.getAttributeValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTopicArn() == null) ? 0 : getTopicArn().hashCode());
hashCode = prime * hashCode + ((getAttributeName() == null) ? 0 : getAttributeName().hashCode());
hashCode = prime * hashCode + ((getAttributeValue() == null) ? 0 : getAttributeValue().hashCode());
return hashCode;
}
@Override
public SetTopicAttributesRequest clone() {
return (SetTopicAttributesRequest) super.clone();
}
}