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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal BoundingBox
Bounding box of the face.static Face.Builder
builder()
final Float
Confidence level that the bounding box contains a face (and not a different object such as a tree).final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Identifier that you assign to all the faces in the input image.final String
faceId()
Unique identifier that Amazon Rekognition assigns to the face.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
imageId()
Unique identifier that Amazon Rekognition assigns to the input image.final String
The version of the face detect and storage model that was used when indexing the face vector.static Class
<? extends Face.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userId()
Unique identifier assigned to the user.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
faceId
Unique identifier that Amazon Rekognition assigns to the face.
- Returns:
- Unique identifier that Amazon Rekognition assigns to the face.
-
boundingBox
Bounding box of the face.
- Returns:
- Bounding box of the face.
-
imageId
Unique identifier that Amazon Rekognition assigns to the input image.
- Returns:
- Unique identifier that Amazon Rekognition assigns to the input image.
-
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
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
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
Unique identifier assigned to the user.
- Returns:
- Unique identifier assigned to the user.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Face.Builder,
Face> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-