software.amazon.awssdk.services.rekognition.model

Interface Face.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Face.Builder,Face>, SdkBuilder<Face.Builder,Face>, SdkPojo

Enclosing class:

Face

public static interface Face.Builder
extends SdkPojo, CopyableBuilder<Face.Builder,Face>

Method Summary

Modifier and Type	Method and Description
Face.Builder	boundingBox(BoundingBox boundingBox) Bounding box of the face.
default Face.Builder	boundingBox(Consumer<BoundingBox.Builder> boundingBox) Bounding box of the face.
Face.Builder	confidence(Float confidence) Confidence level that the bounding box contains a face (and not a different object such as a tree).
Face.Builder	externalImageId(String externalImageId) Identifier that you assign to all the faces in the input image.
Face.Builder	faceId(String faceId) Unique identifier that Amazon Rekognition assigns to the face.
Face.Builder	imageId(String imageId) Unique identifier that Amazon Rekognition assigns to the input image.
Face.Builder	indexFacesModelVersion(String indexFacesModelVersion) The version of the face detect and storage model that was used when indexing the face vector.
Face.Builder	userId(String userId) Unique identifier assigned to the user.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

faceId

Face.Builder faceId(String 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

Face.Builder boundingBox(BoundingBox 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

default Face.Builder boundingBox(Consumer<BoundingBox.Builder> boundingBox)

Bounding box of the face.

This is a convenience method that creates an instance of the BoundingBox.Builder avoiding the need to create one manually via BoundingBox.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to boundingBox(BoundingBox).

Parameters:

boundingBox - a consumer that will call methods on BoundingBox.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

boundingBox(BoundingBox)

imageId

Face.Builder imageId(String 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

Face.Builder externalImageId(String 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

Face.Builder confidence(Float 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

Face.Builder indexFacesModelVersion(String 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

Face.Builder userId(String 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.