software.amazon.awssdk.services.ses.model.StopAction 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 terminates the evaluation of the receipt rule set and, optionally,
* publishes a notification to Amazon Simple Notification Service (Amazon SNS).
*
*
* For information about setting a stop action in a receipt rule, see the Amazon SES Developer
* Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public class StopAction implements ToCopyableBuilder {
private final String scope;
private final String topicArn;
private StopAction(BuilderImpl builder) {
this.scope = builder.scope;
this.topicArn = builder.topicArn;
}
/**
*
* The name of the RuleSet that is being stopped.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #scope} will return
* {@link StopScope#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scopeString}.
*
*
* @return The name of the RuleSet that is being stopped.
* @see StopScope
*/
public StopScope scope() {
return StopScope.fromValue(scope);
}
/**
*
* The name of the RuleSet that is being stopped.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #scope} will return
* {@link StopScope#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scopeString}.
*
*
* @return The name of the RuleSet that is being stopped.
* @see StopScope
*/
public String scopeString() {
return scope;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. 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 when the stop action is taken. 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;
}
@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(scopeString());
hashCode = 31 * hashCode + Objects.hashCode(topicArn());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof StopAction)) {
return false;
}
StopAction other = (StopAction) obj;
return Objects.equals(scopeString(), other.scopeString()) && Objects.equals(topicArn(), other.topicArn());
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder("{");
if (scopeString() != null) {
sb.append("Scope: ").append(scopeString()).append(",");
}
if (topicArn() != null) {
sb.append("TopicArn: ").append(topicArn()).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 "Scope":
return Optional.of(clazz.cast(scopeString()));
case "TopicArn":
return Optional.of(clazz.cast(topicArn()));
default:
return Optional.empty();
}
}
public interface Builder extends CopyableBuilder {
/**
*
* The name of the RuleSet that is being stopped.
*
*
* @param scope
* The name of the RuleSet that is being stopped.
* @see StopScope
* @return Returns a reference to this object so that method calls can be chained together.
* @see StopScope
*/
Builder scope(String scope);
/**
*
* The name of the RuleSet that is being stopped.
*
*
* @param scope
* The name of the RuleSet that is being stopped.
* @see StopScope
* @return Returns a reference to this object so that method calls can be chained together.
* @see StopScope
*/
Builder scope(StopScope scope);
/**
*
* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. 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 when the stop action is taken. 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);
}
static final class BuilderImpl implements Builder {
private String scope;
private String topicArn;
private BuilderImpl() {
}
private BuilderImpl(StopAction model) {
scope(model.scope);
topicArn(model.topicArn);
}
public final String getScope() {
return scope;
}
@Override
public final Builder scope(String scope) {
this.scope = scope;
return this;
}
@Override
public final Builder scope(StopScope scope) {
this.scope(scope.toString());
return this;
}
public final void setScope(String scope) {
this.scope = scope;
}
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;
}
@Override
public StopAction build() {
return new StopAction(this);
}
}
}