Class ContextDataType
- java.lang.Object
-
- software.amazon.awssdk.services.cognitoidentityprovider.model.ContextDataType
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ContextDataType.Builder,ContextDataType>
@Generated("software.amazon.awssdk:codegen") public final class ContextDataType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContextDataType.Builder,ContextDataType>
Contextual user data type 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 interfaceContextDataType.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ContextDataType.Builderbuilder()StringencodedData()Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasHttpHeaders()For responses, this returns true if the service returned a value for the HttpHeaders property.List<HttpHeader>httpHeaders()HttpHeaders received on your server in same order.StringipAddress()The source IP address of your user's device.List<SdkField<?>>sdkFields()static Class<? extends ContextDataType.Builder>serializableBuilderClass()StringserverName()Your server endpoint where this API is invoked.StringserverPath()Your server path where this API is invoked.ContextDataType.BuildertoBuilder()StringtoString()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.
-
serverName
public final String serverName()
Your server endpoint where this API is invoked.
- Returns:
- Your server endpoint where this API is invoked.
-
serverPath
public final String serverPath()
Your server path where this API is invoked.
- Returns:
- Your server path where this API is invoked.
-
hasHttpHeaders
public final boolean hasHttpHeaders()
For responses, this returns true if the service returned a value for the HttpHeaders 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.
-
httpHeaders
public final List<HttpHeader> httpHeaders()
HttpHeaders received on your server in same order.
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
hasHttpHeaders()method.- Returns:
- HttpHeaders received on your server in same order.
-
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 ContextDataType.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ContextDataType.Builder,ContextDataType>
-
builder
public static ContextDataType.Builder builder()
-
serializableBuilderClass
public static Class<? extends ContextDataType.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-