software.amazon.awssdk.services.cognitoidentityprovider.model

Class AuthEventType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.AuthEventType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AuthEventType.Builder,AuthEventType>

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

The authentication event type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthEventType.Builder

Method Summary

Modifier and Type	Method and Description
static AuthEventType.Builder	builder()
List<ChallengeResponseType>	challengeResponses() The challenge responses.
Instant	creationDate() The creation date
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EventContextDataType	eventContextData() The user context data captured at the time of an event request.
EventFeedbackType	eventFeedback() A flag specifying the user feedback captured at the time of an event request is good or bad.
String	eventId() The event ID.
EventResponseType	eventResponse() The event response.
String	eventResponseAsString() The event response.
EventRiskType	eventRisk() The event risk.
EventType	eventType() The event type.
String	eventTypeAsString() The event type.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChallengeResponses() For responses, this returns true if the service returned a value for the ChallengeResponses property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AuthEventType.Builder>	serializableBuilderClass()
AuthEventType.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

EventType

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:

EventType

creationDate

public final Instant creationDate()

The creation date

Returns:

The creation date

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:

EventResponseType

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:

EventResponseType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthEventType.Builder,AuthEventType>

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)

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