Class AuthEventType
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AuthEventType.Builder,
AuthEventType>
The authentication event type.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AuthEventType.Builder
builder()
final List
<ChallengeResponseType> The challenge responses.final Instant
The date and time when the item was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final EventContextDataType
The user context data captured at the time of an event request.final EventFeedbackType
A flag specifying the user feedback captured at the time of an event request is good or bad.final String
eventId()
The event ID.final EventResponseType
The event response.final String
The event response.final EventRiskType
The event risk.final EventType
The event type.final String
The event type.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ChallengeResponses property.final int
hashCode()
static Class
<? extends AuthEventType.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
eventId
The event ID.
- Returns:
- The event ID.
-
eventType
The event type.
If the service returns an enum value that is not available in the current SDK version,
eventType
will returnEventType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventTypeAsString()
.- Returns:
- The event type.
- See Also:
-
eventTypeAsString
The event type.
If the service returns an enum value that is not available in the current SDK version,
eventType
will returnEventType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventTypeAsString()
.- Returns:
- The event type.
- See Also:
-
creationDate
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.- Returns:
- The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time
format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.
-
eventResponse
The event response.
If the service returns an enum value that is not available in the current SDK version,
eventResponse
will returnEventResponseType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventResponseAsString()
.- Returns:
- The event response.
- See Also:
-
eventResponseAsString
The event response.
If the service returns an enum value that is not available in the current SDK version,
eventResponse
will returnEventResponseType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventResponseAsString()
.- Returns:
- The event response.
- See Also:
-
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 theisEmpty()
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
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
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
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
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 interfaceToCopyableBuilder<AuthEventType.Builder,
AuthEventType> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-