software.amazon.awssdk.services.ses.model.StopAction Maven / Gradle / Ivy
Show all versions of ses Show documentation
/*
* Copyright 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.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
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 final class StopAction implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField SCOPE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(StopAction::scopeAsString)).setter(setter(Builder::scope))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Scope").build()).build();
private static final SdkField TOPIC_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(StopAction::topicArn)).setter(setter(Builder::topicArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TopicArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SCOPE_FIELD, TOPIC_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final String scope;
private final String topicArn;
private StopAction(BuilderImpl builder) {
this.scope = builder.scope;
this.topicArn = builder.topicArn;
}
/**
*
* The scope of the StopAction. The only acceptable value is RuleSet.
*
*
* 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 #scopeAsString}.
*
*
* @return The scope of the StopAction. The only acceptable value is RuleSet.
* @see StopScope
*/
public StopScope scope() {
return StopScope.fromValue(scope);
}
/**
*
* The scope of the StopAction. The only acceptable value is RuleSet.
*
*
* 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 #scopeAsString}.
*
*
* @return The scope of the StopAction. The only acceptable value is RuleSet.
* @see StopScope
*/
public String scopeAsString() {
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(scopeAsString());
hashCode = 31 * hashCode + Objects.hashCode(topicArn());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(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(scopeAsString(), other.scopeAsString()) && Objects.equals(topicArn(), other.topicArn());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("StopAction").add("Scope", scopeAsString()).add("TopicArn", topicArn()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Scope":
return Optional.ofNullable(clazz.cast(scopeAsString()));
case "TopicArn":
return Optional.ofNullable(clazz.cast(topicArn()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StopAction) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The scope of the StopAction. The only acceptable value is RuleSet.
*
*
* @param scope
* The scope of the StopAction. The only acceptable value is RuleSet.
* @see StopScope
* @return Returns a reference to this object so that method calls can be chained together.
* @see StopScope
*/
Builder scope(String scope);
/**
*
* The scope of the StopAction. The only acceptable value is RuleSet.
*
*
* @param scope
* The scope of the StopAction. The only acceptable value is RuleSet.
* @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 == null ? null : 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);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}