Package software.amazon.awssdk.services.rekognition.model

Class UnsuccessfulFaceAssociation

java.lang.Object

software.amazon.awssdk.services.rekognition.model.UnsuccessfulFaceAssociation

All Implemented Interfaces:

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

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

Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully associated.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UnsuccessfulFaceAssociation.Builder

Method Summary

Modifier and Type	Method	Description
static UnsuccessfulFaceAssociation.Builder	builder()
Float	confidence()	Match confidence with the UserID, provides information regarding if a face association was unsuccessful because it didn't meet UserMatchThreshold.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	faceId()	A unique identifier assigned to the face.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReasons()	For responses, this returns true if the service returned a value for the Reasons property.
List<UnsuccessfulFaceAssociationReason>	reasons()	The reason why the association was unsuccessful.
List<String>	reasonsAsStrings()	The reason why the association was unsuccessful.
List<SdkField<?>>	sdkFields()
static Class<? extends UnsuccessfulFaceAssociation.Builder>	serializableBuilderClass()
UnsuccessfulFaceAssociation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	A provided ID for the UserID.

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

faceId

public final String faceId()

A unique identifier assigned to the face.

Returns:

A unique identifier assigned to the face.

userId

public final String userId()

A provided ID for the UserID. Unique within the collection.

Returns:

A provided ID for the UserID. Unique within the collection.

confidence

public final Float confidence()

Match confidence with the UserID, provides information regarding if a face association was unsuccessful because it didn't meet UserMatchThreshold.

Returns:

Match confidence with the UserID, provides information regarding if a face association was unsuccessful because it didn't meet UserMatchThreshold.

reasons

public final List<UnsuccessfulFaceAssociationReason> reasons()

The reason why the association was unsuccessful.

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

Returns:

The reason why the association was unsuccessful.

hasReasons

public final boolean hasReasons()

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

reasonsAsStrings

public final List<String> reasonsAsStrings()

The reason why the association was unsuccessful.

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

Returns:

The reason why the association was unsuccessful.

toBuilder

public UnsuccessfulFaceAssociation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UnsuccessfulFaceAssociation.Builder,UnsuccessfulFaceAssociation>

builder

public static UnsuccessfulFaceAssociation.Builder builder()

serializableBuilderClass

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