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

Class UnsearchedFace

java.lang.Object

software.amazon.awssdk.services.rekognition.model.UnsearchedFace

All Implemented Interfaces:

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

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

Face details inferred from the image but not used for search. The response attribute contains reasons for why a face wasn't used for Search.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UnsearchedFace.Builder

Method Summary

Modifier and Type	Method	Description
static UnsearchedFace.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FaceDetail	faceDetails()	Returns the value of the FaceDetails property for this object.
<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<UnsearchedFaceReason>	reasons()	Reasons why a face wasn't used for Search.
List<String>	reasonsAsStrings()	Reasons why a face wasn't used for Search.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UnsearchedFace.Builder>	serializableBuilderClass()
UnsearchedFace.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

faceDetails

public final FaceDetail faceDetails()

Returns the value of the FaceDetails property for this object.

Returns:

The value of the FaceDetails property for this object.

reasons

public final List<UnsearchedFaceReason> reasons()

Reasons why a face wasn't used for Search.

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:

Reasons why a face wasn't used for Search.

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

Reasons why a face wasn't used for Search.

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:

Reasons why a face wasn't used for Search.

toBuilder

public UnsearchedFace.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UnsearchedFace.Builder,UnsearchedFace>

builder

public static UnsearchedFace.Builder builder()

serializableBuilderClass

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