Class RelayAuthentication

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

Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored, or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.

See Also:

  • Method Details

    • secretArn

      public final String secretArn()

      The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.

      Returns:
      The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.

    • noAuthentication

      public final NoAuthentication noAuthentication()

      Keep an empty structure if the relay destination server does not require SMTP credential authentication.

      Returns:
      Keep an empty structure if the relay destination server does not require SMTP credential authentication.

    • toBuilder

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

    • builder

      public static RelayAuthentication.Builder builder()

    • serializableBuilderClass

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

    • fromSecretArn

      public static RelayAuthentication fromSecretArn(String secretArn)
      Create an instance of this class with secretArn() initialized to the given value.

      The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.

      Parameters:
      secretArn - The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.

    • fromNoAuthentication

      public static RelayAuthentication fromNoAuthentication(NoAuthentication noAuthentication)
      Create an instance of this class with noAuthentication() initialized to the given value.

      Keep an empty structure if the relay destination server does not require SMTP credential authentication.

      Parameters:
      noAuthentication - Keep an empty structure if the relay destination server does not require SMTP credential authentication.

    • fromNoAuthentication

      public static RelayAuthentication fromNoAuthentication(Consumer<NoAuthentication.Builder> noAuthentication)
      Create an instance of this class with noAuthentication() initialized to the given value.

      Keep an empty structure if the relay destination server does not require SMTP credential authentication.

      Parameters:
      noAuthentication - Keep an empty structure if the relay destination server does not require SMTP credential authentication.

    • type

      public RelayAuthentication.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be RelayAuthentication.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be RelayAuthentication.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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