software.amazon.awssdk.services.ses.model.SNSAction Maven / Gradle / Ivy
/*
* Copyright 2012-2017 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 software.amazon.awssdk.services.ses.model;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Generated;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public class SNSAction implements ToCopyableBuilder {
private final String topicArn;
private final String encoding;
private SNSAction(BuilderImpl builder) {
this.topicArn = builder.topicArn;
this.encoding = builder.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 topicArn() {
return 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.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #encoding} will
* return {@link SNSActionEncoding#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #encodingString}.
*
*
* @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 SNSActionEncoding encoding() {
return SNSActionEncoding.fromValue(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.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #encoding} will
* return {@link SNSActionEncoding#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #encodingString}.
*
*
* @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 encodingString() {
return encoding;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(topicArn());
hashCode = 31 * hashCode + Objects.hashCode(encodingString());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SNSAction)) {
return false;
}
SNSAction other = (SNSAction) obj;
return Objects.equals(topicArn(), other.topicArn()) && Objects.equals(encodingString(), other.encodingString());
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder("{");
if (topicArn() != null) {
sb.append("TopicArn: ").append(topicArn()).append(",");
}
if (encodingString() != null) {
sb.append("Encoding: ").append(encodingString()).append(",");
}
if (sb.length() > 1) {
sb.setLength(sb.length() - 1);
}
sb.append("}");
return sb.toString();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TopicArn":
return Optional.of(clazz.cast(topicArn()));
case "Encoding":
return Optional.of(clazz.cast(encodingString()));
default:
return Optional.empty();
}
}
public interface Builder extends CopyableBuilder {
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder topicArn(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.
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see SNSActionEncoding
*/
Builder encoding(String 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.
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see SNSActionEncoding
*/
Builder encoding(SNSActionEncoding encoding);
}
static final class BuilderImpl implements Builder {
private String topicArn;
private String encoding;
private BuilderImpl() {
}
private BuilderImpl(SNSAction model) {
topicArn(model.topicArn);
encoding(model.encoding);
}
public final String getTopicArn() {
return topicArn;
}
@Override
public final Builder topicArn(String topicArn) {
this.topicArn = topicArn;
return this;
}
public final void setTopicArn(String topicArn) {
this.topicArn = topicArn;
}
public final String getEncoding() {
return encoding;
}
@Override
public final Builder encoding(String encoding) {
this.encoding = encoding;
return this;
}
@Override
public final Builder encoding(SNSActionEncoding encoding) {
this.encoding(encoding.toString());
return this;
}
public final void setEncoding(String encoding) {
this.encoding = encoding;
}
@Override
public SNSAction build() {
return new SNSAction(this);
}
}
}