com.amazonaws.services.cognitoidp.model

Class UserContextDataType

java.lang.Object

com.amazonaws.services.cognitoidp.model.UserContextDataType

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserContextDataType
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserContextDataType()

Method Summary

Modifier and Type	Method and Description
UserContextDataType	clone()
boolean	equals(Object obj)
String	getEncodedData() Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library.
String	getIpAddress() The source IP address of your user's device.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setEncodedData(String encodedData) Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library.
void	setIpAddress(String ipAddress) The source IP address of your user's device.
String	toString() Returns a string representation of this object.
UserContextDataType	withEncodedData(String encodedData) Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library.
UserContextDataType	withIpAddress(String ipAddress) The source IP address of your user's device.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserContextDataType

public UserContextDataType()

Method Detail

setIpAddress

public void setIpAddress(String ipAddress)

The source IP address of your user's device.

Parameters:

ipAddress - The source IP address of your user's device.

getIpAddress

public String getIpAddress()

The source IP address of your user's device.

Returns:

The source IP address of your user's device.

withIpAddress

public UserContextDataType withIpAddress(String ipAddress)

The source IP address of your user's device.

Parameters:

ipAddress - The source IP address of your user's device.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEncodedData

public void setEncodedData(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.

Parameters:

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.

getEncodedData

public String getEncodedData()

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.

withEncodedData

public UserContextDataType withEncodedData(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UserContextDataType clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.