/* * Copyright 2010-2020 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.simpleemail.model; import java.io.Serializable; /** *

* When included in a receipt rule, this action publishes a notification to * Amazon Simple Notification Service (Amazon SNS). This action includes a * complete copy of the email content in the Amazon SNS notifications. Amazon * SNS notifications for all other actions simply provide information about the * email. They do not include the email content itself. *

*

* If you own the Amazon SNS topic, you don't need to do anything to give Amazon * SES permission to publish emails to it. However, if you don't own the Amazon * SNS topic, you need to attach a policy to the topic to give Amazon SES * permissions to access it. For information about giving permissions, see the * Amazon SES Developer Guide. *

* *

* You can only publish emails that are 150 KB or less (including the header) to * Amazon SNS. Larger emails will bounce. If you anticipate emails larger than * 150 KB, use the S3 action instead. *

* *

* For information about using a receipt rule to publish an Amazon SNS * notification, see the Amazon SES Developer Guide. *

*/ public class SNSAction implements Serializable { /** *

* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An * example of an Amazon SNS topic ARN is * arn:aws:sns:us-west-2:123456789012:MyTopic. For more * information about Amazon SNS topics, see the Amazon * SNS Developer Guide. *

*/ private String topicArn; /** *

* The encoding to use for the email within the Amazon SNS notification. * UTF-8 is easier to use, but may not preserve all special characters when * a message was encoded with a different encoding format. Base64 preserves * all special characters. The default value is UTF-8. *

*

* Constraints:
* Allowed Values: UTF-8, Base64 */ private String encoding; /** *

* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An * example of an Amazon SNS topic ARN is * arn:aws:sns:us-west-2:123456789012:MyTopic. For more * information about Amazon SNS topics, see the Amazon * SNS Developer Guide. *

* * @return

* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. * An example of an Amazon SNS topic ARN is * arn:aws:sns:us-west-2:123456789012:MyTopic. For more * information about Amazon SNS topics, see the Amazon SNS Developer Guide. *

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

* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An * example of an Amazon SNS topic ARN is * arn:aws:sns:us-west-2:123456789012:MyTopic. For more * information about Amazon SNS topics, see the Amazon * SNS Developer Guide. *

* * @param topicArn

* The Amazon Resource Name (ARN) of the Amazon SNS topic to * notify. An example of an Amazon SNS topic ARN is * arn:aws:sns:us-west-2:123456789012:MyTopic. For * more information about Amazon SNS topics, see the Amazon SNS Developer Guide. *

*/ public void setTopicArn(String topicArn) { this.topicArn = topicArn; } /** *

* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An * example of an Amazon SNS topic ARN is * arn:aws:sns:us-west-2:123456789012:MyTopic. For more * information about Amazon SNS topics, see the Amazon * SNS Developer Guide. *

*

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

* The Amazon Resource Name (ARN) of the Amazon SNS topic to * notify. An example of an Amazon SNS topic ARN is * arn:aws:sns:us-west-2:123456789012:MyTopic. For * more information about Amazon SNS topics, see the Amazon SNS Developer Guide. *

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

* The encoding to use for the email within the Amazon SNS notification. * UTF-8 is easier to use, but may not preserve all special characters when * a message was encoded with a different encoding format. Base64 preserves * all special characters. The default value is UTF-8. *

*

* Constraints:
* Allowed Values: UTF-8, Base64 * * @return

* The encoding to use for the email within the Amazon SNS * notification. UTF-8 is easier to use, but may not preserve all * special characters when a message was encoded with a different * encoding format. Base64 preserves all special characters. The * default value is UTF-8. *

* @see SNSActionEncoding */ public String getEncoding() { return encoding; } /** *

* The encoding to use for the email within the Amazon SNS notification. * UTF-8 is easier to use, but may not preserve all special characters when * a message was encoded with a different encoding format. Base64 preserves * all special characters. The default value is UTF-8. *

*

* Constraints:
* Allowed Values: UTF-8, Base64 * * @param encoding

* The encoding to use for the email within the Amazon SNS * notification. UTF-8 is easier to use, but may not preserve all * special characters when a message was encoded with a different * encoding format. Base64 preserves all special characters. The * default value is UTF-8. *

* @see SNSActionEncoding */ public void setEncoding(String encoding) { this.encoding = encoding; } /** *

* The encoding to use for the email within the Amazon SNS notification. * UTF-8 is easier to use, but may not preserve all special characters when * a message was encoded with a different encoding format. Base64 preserves * all special characters. The default value is UTF-8. *

*

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

* Constraints:
* Allowed Values: UTF-8, Base64 * * @param encoding

* The encoding to use for the email within the Amazon SNS * notification. UTF-8 is easier to use, but may not preserve all * special characters when a message was encoded with a different * encoding format. Base64 preserves all special characters. The * default value is UTF-8. *

* @return A reference to this updated object so that method calls can be * chained together. * @see SNSActionEncoding */ public SNSAction withEncoding(String encoding) { this.encoding = encoding; return this; } /** *

* The encoding to use for the email within the Amazon SNS notification. * UTF-8 is easier to use, but may not preserve all special characters when * a message was encoded with a different encoding format. Base64 preserves * all special characters. The default value is UTF-8. *

*

* Constraints:
* Allowed Values: UTF-8, Base64 * * @param encoding

* The encoding to use for the email within the Amazon SNS * notification. UTF-8 is easier to use, but may not preserve all * special characters when a message was encoded with a different * encoding format. Base64 preserves all special characters. The * default value is UTF-8. *

* @see SNSActionEncoding */ public void setEncoding(SNSActionEncoding encoding) { this.encoding = encoding.toString(); } /** *

* The encoding to use for the email within the Amazon SNS notification. * UTF-8 is easier to use, but may not preserve all special characters when * a message was encoded with a different encoding format. Base64 preserves * all special characters. The default value is UTF-8. *

*

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

* Constraints:
* Allowed Values: UTF-8, Base64 * * @param encoding

* The encoding to use for the email within the Amazon SNS * notification. UTF-8 is easier to use, but may not preserve all * special characters when a message was encoded with a different * encoding format. Base64 preserves all special characters. The * default value is UTF-8. *

* @return A reference to this updated object so that method calls can be * chained together. * @see SNSActionEncoding */ public SNSAction withEncoding(SNSActionEncoding encoding) { this.encoding = encoding.toString(); 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 (getEncoding() != null) sb.append("Encoding: " + getEncoding()); 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 + ((getEncoding() == null) ? 0 : getEncoding().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SNSAction == false) return false; SNSAction other = (SNSAction) obj; if (other.getTopicArn() == null ^ this.getTopicArn() == null) return false; if (other.getTopicArn() != null && other.getTopicArn().equals(this.getTopicArn()) == false) return false; if (other.getEncoding() == null ^ this.getEncoding() == null) return false; if (other.getEncoding() != null && other.getEncoding().equals(this.getEncoding()) == false) return false; return true; } }