Class NotifyCodeConfiguration

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

Contains the settings of a notify code configuration, which is a reusable one-time passcode policy.

See Also:

  • Method Details

    • notifyCodeConfigurationId

      public final String notifyCodeConfigurationId()

      The unique identifier of the notify code configuration.

      Returns:
      The unique identifier of the notify code configuration.

    • notifyCodeConfigurationArn

      public final String notifyCodeConfigurationArn()

      The Amazon Resource Name (ARN) of the notify code configuration.

      Returns:
      The Amazon Resource Name (ARN) of the notify code configuration.

    • notifyCodeConfigurationName

      public final String notifyCodeConfigurationName()

      The name of the notify code configuration.

      Returns:
      The name of the notify code configuration.

    • codeConfigurationParameters

      public final CodeConfigurationParameters codeConfigurationParameters()

      The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.

      Returns:
      The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.

    • channelParameters

      public final ChannelParameters channelParameters()

      The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.

      Returns:
      The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.

    • deletionProtectionEnabled

      public final Boolean deletionProtectionEnabled()

      Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

      Returns:
      Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

    • createdAt

      public final Instant createdAt()

      The time when the resource was created, in Unix epoch time.

      Returns:
      The time when the resource was created, in Unix epoch time.

    • updatedAt

      public final Instant updatedAt()

      The time when the resource was last updated, in Unix epoch time.

      Returns:
      The time when the resource was last updated, in Unix epoch time.

    • toBuilder

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

    • builder

      public static NotifyCodeConfiguration.Builder builder()

    • serializableBuilderClass

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