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

Class UserContextDataType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.UserContextDataType

All Implemented Interfaces:

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

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

Contextual data, such as the user's device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserContextDataType.Builder

Method Summary

Modifier and Type	Method	Description
static UserContextDataType.Builder	builder()
String	encodedData()	Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	ipAddress()	The source IP address of your user's device.
List<SdkField<?>>	sdkFields()
static Class<? extends UserContextDataType.Builder>	serializableBuilderClass()
UserContextDataType.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

ipAddress

public final String ipAddress()

The source IP address of your user's device.

Returns:

The source IP address of your user's device.

encodedData

public final String encodedData()

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

Returns:

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

toBuilder

public UserContextDataType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserContextDataType.Builder,UserContextDataType>

builder

public static UserContextDataType.Builder builder()

serializableBuilderClass

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