Class RuleDmarcExpression

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

A DMARC policy expression. The condition matches if the given DMARC policy matches that of the incoming email.

See Also:

  • Method Details

    • operator

      public final RuleDmarcOperator operator()

      The operator to apply to the DMARC policy of the incoming email.

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

      Returns:
      The operator to apply to the DMARC policy of the incoming email.
      See Also:

    • operatorAsString

      public final String operatorAsString()

      The operator to apply to the DMARC policy of the incoming email.

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

      Returns:
      The operator to apply to the DMARC policy of the incoming email.
      See Also:

    • values

      public final List<RuleDmarcPolicy> values()

      The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

      Returns:
      The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • valuesAsStrings

      public final List<String> valuesAsStrings()

      The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

      Returns:
      The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.

    • toBuilder

      public RuleDmarcExpression.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<RuleDmarcExpression.Builder,RuleDmarcExpression>
      Returns:
      a builder for type T

    • builder

      public static RuleDmarcExpression.Builder builder()

    • serializableBuilderClass

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