ContextDataType (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidp.model.ContextDataType

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ContextDataType
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contextual user data type 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

ContextDataType()

Constructors
Constructor and Description
`ContextDataType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContextDataType`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getEncodedData()` Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
`List<HttpHeader>`	`getHttpHeaders()` HttpHeaders received on your server in same order.
`String`	`getIpAddress()` Source IP address of your user.
`String`	`getServerName()` Your server endpoint where this API is invoked.
`String`	`getServerPath()` Your server path where this API is invoked.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEncodedData(String encodedData)` Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
`void`	`setHttpHeaders(Collection<HttpHeader> httpHeaders)` HttpHeaders received on your server in same order.
`void`	`setIpAddress(String ipAddress)` Source IP address of your user.
`void`	`setServerName(String serverName)` Your server endpoint where this API is invoked.
`void`	`setServerPath(String serverPath)` Your server path where this API is invoked.
`String`	`toString()` Returns a string representation of this object.
`ContextDataType`	`withEncodedData(String encodedData)` Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
`ContextDataType`	`withHttpHeaders(Collection<HttpHeader> httpHeaders)` HttpHeaders received on your server in same order.
`ContextDataType`	`withHttpHeaders(HttpHeader... httpHeaders)` HttpHeaders received on your server in same order.
`ContextDataType`	`withIpAddress(String ipAddress)` Source IP address of your user.
`ContextDataType`	`withServerName(String serverName)` Your server endpoint where this API is invoked.
`ContextDataType`	`withServerPath(String serverPath)` Your server path where this API is invoked.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ContextDataType
```
public ContextDataType()
```
- Method Detail
  - setIpAddress
```
public void setIpAddress(String ipAddress)
```
    Source IP address of your user.
    
    Parameters:
    
    ipAddress - Source IP address of your user.
  - getIpAddress
```
public String getIpAddress()
```
    Source IP address of your user.
    
    Returns:
    
    Source IP address of your user.
  - withIpAddress
```
public ContextDataType withIpAddress(String ipAddress)
```
    Source IP address of your user.
    
    Parameters:
    
    ipAddress - Source IP address of your user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerName
```
public void setServerName(String serverName)
```
    Your server endpoint where this API is invoked.
    
    Parameters:
    
    serverName - Your server endpoint where this API is invoked.
  - getServerName
```
public String getServerName()
```
    Your server endpoint where this API is invoked.
    
    Returns:
    
    Your server endpoint where this API is invoked.
  - withServerName
```
public ContextDataType withServerName(String serverName)
```
    Your server endpoint where this API is invoked.
    
    Parameters:
    
    serverName - Your server endpoint where this API is invoked.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerPath
```
public void setServerPath(String serverPath)
```
    Your server path where this API is invoked.
    
    Parameters:
    
    serverPath - Your server path where this API is invoked.
  - getServerPath
```
public String getServerPath()
```
    Your server path where this API is invoked.
    
    Returns:
    
    Your server path where this API is invoked.
  - withServerPath
```
public ContextDataType withServerPath(String serverPath)
```
    Your server path where this API is invoked.
    
    Parameters:
    
    serverPath - Your server path where this API is invoked.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getHttpHeaders
```
public List<HttpHeader> getHttpHeaders()
```
    HttpHeaders received on your server in same order.
    
    Returns:
    
    HttpHeaders received on your server in same order.
  - setHttpHeaders
```
public void setHttpHeaders(Collection<HttpHeader> httpHeaders)
```
    HttpHeaders received on your server in same order.
    
    Parameters:
    
    httpHeaders - HttpHeaders received on your server in same order.
  - withHttpHeaders
```
public ContextDataType withHttpHeaders(HttpHeader... httpHeaders)
```
    HttpHeaders received on your server in same order.
    
    NOTE: This method appends the values to the existing list (if any). Use setHttpHeaders(java.util.Collection) or withHttpHeaders(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    httpHeaders - HttpHeaders received on your server in same order.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withHttpHeaders
```
public ContextDataType withHttpHeaders(Collection<HttpHeader> httpHeaders)
```
    HttpHeaders received on your server in same order.
    
    Parameters:
    
    httpHeaders - HttpHeaders received on your server in same order.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEncodedData
```
public void setEncodedData(String encodedData)
```
    Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
    
    Parameters:
    
    encodedData - Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
  - getEncodedData
```
public String getEncodedData()
```
    Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
    
    Returns:
    
    Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
  - withEncodedData
```
public ContextDataType withEncodedData(String encodedData)
```
    Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
    
    Parameters:
    
    encodedData - Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
    
    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 ContextDataType 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.

Did this page help you?

Class ContextDataType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContextDataType

Method Detail

setIpAddress

getIpAddress

withIpAddress

setServerName

getServerName

withServerName

setServerPath

getServerPath

withServerPath

getHttpHeaders

setHttpHeaders

withHttpHeaders

withHttpHeaders

setEncodedData

getEncodedData

withEncodedData

toString

equals

hashCode

clone

marshall