Interface Face.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Face.Builder,
,Face> SdkBuilder<Face.Builder,
,Face> SdkPojo
- Enclosing class:
Face
@Mutable
@NotThreadSafe
public static interface Face.Builder
extends SdkPojo, CopyableBuilder<Face.Builder,Face>
-
Method Summary
Modifier and TypeMethodDescriptiondefault Face.Builder
boundingBox
(Consumer<BoundingBox.Builder> boundingBox) Bounding box of the face.boundingBox
(BoundingBox boundingBox) Bounding box of the face.confidence
(Float confidence) Confidence level that the bounding box contains a face (and not a different object such as a tree).externalImageId
(String externalImageId) Identifier that you assign to all the faces in the input image.Unique identifier that Amazon Rekognition assigns to the face.Unique identifier that Amazon Rekognition assigns to the input image.indexFacesModelVersion
(String indexFacesModelVersion) The version of the face detect and storage model that was used when indexing the face vector.Unique identifier assigned to the user.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
faceId
Unique identifier that Amazon Rekognition assigns to the face.
- Parameters:
faceId
- Unique identifier that Amazon Rekognition assigns to the face.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
boundingBox
Bounding box of the face.
- Parameters:
boundingBox
- Bounding box of the face.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
boundingBox
Bounding box of the face.
This is a convenience method that creates an instance of theBoundingBox.Builder
avoiding the need to create one manually viaBoundingBox.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toboundingBox(BoundingBox)
.- Parameters:
boundingBox
- a consumer that will call methods onBoundingBox.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imageId
Unique identifier that Amazon Rekognition assigns to the input image.
- Parameters:
imageId
- Unique identifier that Amazon Rekognition assigns to the input image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalImageId
Identifier that you assign to all the faces in the input image.
- Parameters:
externalImageId
- Identifier that you assign to all the faces in the input image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
confidence
Confidence level that the bounding box contains a face (and not a different object such as a tree).
- Parameters:
confidence
- Confidence level that the bounding box contains a face (and not a different object such as a tree).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexFacesModelVersion
The version of the face detect and storage model that was used when indexing the face vector.
- Parameters:
indexFacesModelVersion
- The version of the face detect and storage model that was used when indexing the face vector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userId
Unique identifier assigned to the user.
- Parameters:
userId
- Unique identifier assigned to the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-