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

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 used for evaluating the risk of an authentication event by user pool threat protection.

See Also:

  • Method Details

    • 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()

      The name of your application's service endpoint.

      Returns:
      The name of your application's service endpoint.

    • serverPath

      public final String serverPath()

      The path of your application's service endpoint.

      Returns:
      The path of your application's service endpoint.

    • 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 the isEmpty() 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()

      The HTTP headers from your user's authentication request.

      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:
      The HTTP headers from your user's authentication request.

    • 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:
      toBuilder in interface ToCopyableBuilder<ContextDataType.Builder,ContextDataType>

    • builder

      public static ContextDataType.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo