Package software.amazon.awssdk.services.ses.model

Class StopAction

java.lang.Object

software.amazon.awssdk.services.ses.model.StopAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StopAction.Builder,StopAction>

@Generated("software.amazon.awssdk:codegen")
public final class StopAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StopAction.Builder,StopAction>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StopAction.Builder

Method Summary

Modifier and Type	Method	Description
static StopAction.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
StopScope	scope()	The scope of the StopAction.
String	scopeAsString()	The scope of the StopAction.
List<SdkField<?>>	sdkFields()
static Class<? extends StopAction.Builder>	serializableBuilderClass()
StopAction.Builder	toBuilder()
String	topicArn()	The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

scope

public final StopScope 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, scope will return StopScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

Returns:

The scope of the StopAction. The only acceptable value is RuleSet.

See Also:

StopScope

scopeAsString

public final String scopeAsString()

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, scope will return StopScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

Returns:

The scope of the StopAction. The only acceptable value is RuleSet.

See Also:

StopScope

topicArn

public final String topicArn()

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Returns:

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

toBuilder

public StopAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StopAction.Builder,StopAction>

builder

public static StopAction.Builder builder()

serializableBuilderClass

public static Class<? extends StopAction.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo