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

Class Face

java.lang.Object

software.amazon.awssdk.services.rekognition.model.Face

All Implemented Interfaces:

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

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

Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Face.Builder

Method Summary

Modifier and Type	Method	Description
BoundingBox	boundingBox()	Bounding box of the face.
static Face.Builder	builder()
Float	confidence()	Confidence level that the bounding box contains a face (and not a different object such as a tree).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalImageId()	Identifier that you assign to all the faces in the input image.
String	faceId()	Unique identifier that Amazon Rekognition assigns to the face.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	imageId()	Unique identifier that Amazon Rekognition assigns to the input image.
String	indexFacesModelVersion()	The version of the face detect and storage model that was used when indexing the face vector.
List<SdkField<?>>	sdkFields()
static Class<? extends Face.Builder>	serializableBuilderClass()
Face.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	Unique identifier assigned to the user.

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

Unique identifier that Amazon Rekognition assigns to the face.

Returns:

Unique identifier that Amazon Rekognition assigns to the face.

boundingBox

public final BoundingBox boundingBox()

Bounding box of the face.

Returns:

Bounding box of the face.

imageId

public final String imageId()

Unique identifier that Amazon Rekognition assigns to the input image.

Returns:

Unique identifier that Amazon Rekognition assigns to the input image.

externalImageId

public final String externalImageId()

Identifier that you assign to all the faces in the input image.

Returns:

Identifier that you assign to all the faces in the input image.

confidence

public final Float confidence()

Confidence level that the bounding box contains a face (and not a different object such as a tree).

Returns:

Confidence level that the bounding box contains a face (and not a different object such as a tree).

indexFacesModelVersion

public final String indexFacesModelVersion()

The version of the face detect and storage model that was used when indexing the face vector.

Returns:

The version of the face detect and storage model that was used when indexing the face vector.

userId

public final String userId()

Unique identifier assigned to the user.

Returns:

Unique identifier assigned to the user.

toBuilder

public Face.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Face.Builder,Face>

builder

public static Face.Builder builder()

serializableBuilderClass

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