Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AccountRecoverySettingType

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

The settings for user message delivery in forgot-password operations. Contains preference for email or SMS message delivery of password reset codes, or for admin-only password reset.

See Also:

  • Method Details

    • hasRecoveryMechanisms

      public final boolean hasRecoveryMechanisms()
      For responses, this returns true if the service returned a value for the RecoveryMechanisms 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.

    • recoveryMechanisms

      public final List<RecoveryOptionType> recoveryMechanisms()

      The list of options and priorities for user message delivery in forgot-password operations. Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators.

      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 hasRecoveryMechanisms() method.

      Returns:
      The list of options and priorities for user message delivery in forgot-password operations. Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators.

    • toBuilder

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

    • builder

      public static AccountRecoverySettingType.Builder builder()

    • serializableBuilderClass

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