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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StopAction.Builder,StopAction>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.