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

Class ReceiptIpFilter

java.lang.Object
software.amazon.awssdk.services.ses.model.ReceiptIpFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReceiptIpFilter.Builder,ReceiptIpFilter>
@Generated("software.amazon.awssdk:codegen") public final class ReceiptIpFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReceiptIpFilter.Builder,ReceiptIpFilter>

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

See Also:

  • Method Details

    • policy

      public final ReceiptFilterPolicy policy()

      Indicates whether to block or allow incoming mail from the specified IP addresses.

      If the service returns an enum value that is not available in the current SDK version, policy will return ReceiptFilterPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyAsString().

      Returns:
      Indicates whether to block or allow incoming mail from the specified IP addresses.
      See Also:

    • policyAsString

      public final String policyAsString()

      Indicates whether to block or allow incoming mail from the specified IP addresses.

      If the service returns an enum value that is not available in the current SDK version, policy will return ReceiptFilterPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyAsString().

      Returns:
      Indicates whether to block or allow incoming mail from the specified IP addresses.
      See Also:

    • cidr

      public final String cidr()

      A single IP address or a range of IP addresses to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.

      Returns:
      A single IP address or a range of IP addresses to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.

    • toBuilder

      public ReceiptIpFilter.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ReceiptIpFilter.Builder,ReceiptIpFilter>

    • builder

      public static ReceiptIpFilter.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ReceiptIpFilter.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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo