/* * Copyright 2010-2023 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 com.amazonaws.AmazonWebServiceRequest; /** *

* Allows a topic owner to set an attribute of the topic to a new value. *

* *

* To remove the ability to change topic permissions, you must deny permissions * to the AddPermission, RemovePermission, and * SetTopicAttributes actions in your IAM policy. *

* */ public class SetTopicAttributesRequest extends AmazonWebServiceRequest implements Serializable { /** *

* 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: *

* * *

* The <ENDPOINT>SuccessFeedbackRoleArn and * <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon * SNS write access to use CloudWatch Logs on your behalf. The * <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the * sample rate percentage (0-100) of successfully delivered messages. After * you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then * all failed message deliveries generate CloudWatch Logs. *

* *

* The following attribute applies only to server-side-encryption: *

* *

* The following attribute applies only to FIFO topics: *

* */ 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 any * additional object members. */ 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: *

* * *

* The <ENDPOINT>SuccessFeedbackRoleArn and * <ENDPOINT>FailureFeedbackRoleArn attributes are used to * give Amazon SNS write access to use CloudWatch Logs on your * behalf. The <ENDPOINT>SuccessFeedbackSampleRate * attribute is for specifying the sample rate percentage (0-100) * of successfully delivered messages. After you configure the * <ENDPOINT>FailureFeedbackRoleArn attribute, then all * failed message deliveries generate CloudWatch Logs. *

* *

* The following attribute applies only to server-side-encryption: *

* *

* The following attribute applies only to FIFO topics: *

* * @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. *

* * @return

* The ARN of the topic to modify. *

*/ public String getTopicArn() { return topicArn; } /** *

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

*

* Returns a reference to this object so that method calls can be chained * together. * * @param topicArn

* The ARN of the topic to modify. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SetTopicAttributesRequest withTopicArn(String topicArn) { this.topicArn = 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: *

* * *

* The <ENDPOINT>SuccessFeedbackRoleArn and * <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon * SNS write access to use CloudWatch Logs on your behalf. The * <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the * sample rate percentage (0-100) of successfully delivered messages. After * you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then * all failed message deliveries generate CloudWatch Logs. *

* *

* The following attribute applies only to server-side-encryption: *

* *

* The following attribute applies only to FIFO topics: *

* * * @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: *

* * *

* The <ENDPOINT>SuccessFeedbackRoleArn and * <ENDPOINT>FailureFeedbackRoleArn attributes are used to * give Amazon SNS write access to use CloudWatch Logs on your * behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute * is for specifying the sample rate percentage (0-100) of * successfully delivered messages. After you configure the * <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed * message deliveries generate CloudWatch Logs. *

* *

* The following attribute applies only to server-side-encryption: *

* *

* The following attribute applies only to FIFO topics: *

* */ public String getAttributeName() { return 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: *

* * *

* The <ENDPOINT>SuccessFeedbackRoleArn and * <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon * SNS write access to use CloudWatch Logs on your behalf. The * <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the * sample rate percentage (0-100) of successfully delivered messages. After * you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then * all failed message deliveries generate CloudWatch Logs. *

* *

* The following attribute applies only to server-side-encryption: *

* *

* The following attribute applies only to FIFO topics: *

* * * @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: *

* * *

* The <ENDPOINT>SuccessFeedbackRoleArn and * <ENDPOINT>FailureFeedbackRoleArn attributes are used to * give Amazon SNS write access to use CloudWatch Logs on your * behalf. The <ENDPOINT>SuccessFeedbackSampleRate * attribute is for specifying the sample rate percentage (0-100) * of successfully delivered messages. After you configure the * <ENDPOINT>FailureFeedbackRoleArn attribute, then all * failed message deliveries generate CloudWatch Logs. *

* *

* The following attribute applies only to server-side-encryption: *

* *

* The following attribute applies only to FIFO topics: *

* */ 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: *

* * *

* The <ENDPOINT>SuccessFeedbackRoleArn and * <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon * SNS write access to use CloudWatch Logs on your behalf. The * <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the * sample rate percentage (0-100) of successfully delivered messages. After * you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then * all failed message deliveries generate CloudWatch Logs. *

* *

* The following attribute applies only to server-side-encryption: *

* *

* The following attribute applies only to FIFO topics: *

* *

* Returns a reference to this object so that method calls can be chained * together. * * @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: *

* * *

* The <ENDPOINT>SuccessFeedbackRoleArn and * <ENDPOINT>FailureFeedbackRoleArn attributes are used to * give Amazon SNS write access to use CloudWatch Logs on your * behalf. The <ENDPOINT>SuccessFeedbackSampleRate * attribute is for specifying the sample rate percentage (0-100) * of successfully delivered messages. After you configure the * <ENDPOINT>FailureFeedbackRoleArn attribute, then all * failed message deliveries generate CloudWatch Logs. *

* *

* The following attribute applies only to server-side-encryption: *

* *

* The following attribute applies only to FIFO topics: *

* * @return A reference to this updated object so that method calls can be * chained together. */ public SetTopicAttributesRequest withAttributeName(String attributeName) { this.attributeName = attributeName; return this; } /** *

* The new value for the attribute. *

* * @return

* The new value for the attribute. *

*/ public String getAttributeValue() { return attributeValue; } /** *

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

*

* Returns a reference to this object so that method calls can be chained * together. * * @param attributeValue

* The new value for the attribute. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SetTopicAttributesRequest withAttributeValue(String attributeValue) { this.attributeValue = attributeValue; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @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: " + getTopicArn() + ","); if (getAttributeName() != null) sb.append("AttributeName: " + getAttributeName() + ","); if (getAttributeValue() != null) sb.append("AttributeValue: " + getAttributeValue()); sb.append("}"); return sb.toString(); } @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 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; } }