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

Class DeviceType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.DeviceType

All Implemented Interfaces:

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

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

Information about a user's device that they've registered for device SRP authentication in your application. For more information, see Working with user devices in your user pool.

The data type is a response parameter of AdminGetDevice, AdminListDevices, and GetDevice.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeviceType.Builder

Method Summary

Modifier and Type	Method	Description
static DeviceType.Builder	builder()
List<AttributeType>	deviceAttributes()	Metadata about a user's device, like name and last-access source IP.
Instant	deviceCreateDate()	The date and time when the item was created.
String	deviceKey()	The device key, for example us-west-2_EXAMPLE-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Instant	deviceLastAuthenticatedDate()	The date when the user last signed in with the device.
Instant	deviceLastModifiedDate()	The date and time when the item was modified.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDeviceAttributes()	For responses, this returns true if the service returned a value for the DeviceAttributes property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DeviceType.Builder>	serializableBuilderClass()
DeviceType.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

deviceKey

public final String deviceKey()

The device key, for example us-west-2_EXAMPLE-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

Returns:

The device key, for example us-west-2_EXAMPLE-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

hasDeviceAttributes

public final boolean hasDeviceAttributes()

For responses, this returns true if the service returned a value for the DeviceAttributes 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.

deviceAttributes

public final List<AttributeType> deviceAttributes()

Metadata about a user's device, like name and last-access source IP.

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 hasDeviceAttributes() method.

Returns:

Metadata about a user's device, like name and last-access source IP.

deviceCreateDate

public final Instant deviceCreateDate()

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

deviceLastModifiedDate

public final Instant deviceLastModifiedDate()

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

deviceLastAuthenticatedDate

public final Instant deviceLastAuthenticatedDate()

The date when the user last signed in with the device.

Returns:

The date when the user last signed in with the device.

toBuilder

public DeviceType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeviceType.Builder,DeviceType>

builder

public static DeviceType.Builder builder()

serializableBuilderClass

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