java.lang.Object
software.amazon.awssdk.services.cognitoidentityprovider.model.AuthEventType
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AuthEventType.Builder,AuthEventType>

@Generated("software.amazon.awssdk:codegen") public final class AuthEventType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AuthEventType.Builder,AuthEventType>

The authentication event type.

See Also:
  • Method Details

    • eventId

      public final String eventId()

      The event ID.

      Returns:
      The event ID.
    • eventType

      public final EventType eventType()

      The event type.

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

      Returns:
      The event type.
      See Also:
    • eventTypeAsString

      public final String eventTypeAsString()

      The event type.

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

      Returns:
      The event type.
      See Also:
    • creationDate

      public final Instant creationDate()

      The date and time, in ISO 8601 format, when the item was created.

      Returns:
      The date and time, in ISO 8601 format, when the item was created.
    • eventResponse

      public final EventResponseType eventResponse()

      The event response.

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

      Returns:
      The event response.
      See Also:
    • eventResponseAsString

      public final String eventResponseAsString()

      The event response.

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

      Returns:
      The event response.
      See Also:
    • eventRisk

      public final EventRiskType eventRisk()

      The event risk.

      Returns:
      The event risk.
    • hasChallengeResponses

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

      public final List<ChallengeResponseType> challengeResponses()

      The challenge responses.

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

      Returns:
      The challenge responses.
    • eventContextData

      public final EventContextDataType eventContextData()

      The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.

      Returns:
      The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.
    • eventFeedback

      public final EventFeedbackType eventFeedback()

      A flag specifying the user feedback captured at the time of an event request is good or bad.

      Returns:
      A flag specifying the user feedback captured at the time of an event request is good or bad.
    • toBuilder

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

      public static AuthEventType.Builder builder()
    • serializableBuilderClass

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