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

Interface SearchFacesByImageResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<SearchFacesByImageResponse.Builder,SearchFacesByImageResponse>, RekognitionResponse.Builder, SdkBuilder<SearchFacesByImageResponse.Builder,SearchFacesByImageResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

SearchFacesByImageResponse

public static interface SearchFacesByImageResponse.Builder
extends RekognitionResponse.Builder, SdkPojo, CopyableBuilder<SearchFacesByImageResponse.Builder,SearchFacesByImageResponse>

Method Summary

Modifier and Type	Method	Description
SearchFacesByImageResponse.Builder	faceMatches(Collection<FaceMatch> faceMatches)	An array of faces that match the input face, along with the confidence in the match.
SearchFacesByImageResponse.Builder	faceMatches(Consumer<FaceMatch.Builder>... faceMatches)	An array of faces that match the input face, along with the confidence in the match.
SearchFacesByImageResponse.Builder	faceMatches(FaceMatch... faceMatches)	An array of faces that match the input face, along with the confidence in the match.
SearchFacesByImageResponse.Builder	faceModelVersion(String faceModelVersion)	Version number of the face detection model associated with the input collection (CollectionId).
default SearchFacesByImageResponse.Builder	searchedFaceBoundingBox(Consumer<BoundingBox.Builder> searchedFaceBoundingBox)	The bounding box around the face in the input image that Amazon Rekognition used for the search.
SearchFacesByImageResponse.Builder	searchedFaceBoundingBox(BoundingBox searchedFaceBoundingBox)	The bounding box around the face in the input image that Amazon Rekognition used for the search.
SearchFacesByImageResponse.Builder	searchedFaceConfidence(Float searchedFaceConfidence)	The level of confidence that the searchedFaceBoundingBox, contains a face.

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

copy

Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

searchedFaceBoundingBox

SearchFacesByImageResponse.Builder searchedFaceBoundingBox(BoundingBox searchedFaceBoundingBox)

The bounding box around the face in the input image that Amazon Rekognition used for the search.

Parameters:

searchedFaceBoundingBox - The bounding box around the face in the input image that Amazon Rekognition used for the search.

Returns:

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

searchedFaceBoundingBox

default SearchFacesByImageResponse.Builder searchedFaceBoundingBox(Consumer<BoundingBox.Builder> searchedFaceBoundingBox)

The bounding box around the face in the input image that Amazon Rekognition used for the search.

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 searchedFaceBoundingBox(BoundingBox).

Parameters:

searchedFaceBoundingBox - 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:

searchedFaceBoundingBox(BoundingBox)

searchedFaceConfidence

SearchFacesByImageResponse.Builder searchedFaceConfidence(Float searchedFaceConfidence)

The level of confidence that the searchedFaceBoundingBox, contains a face.

Parameters:

searchedFaceConfidence - The level of confidence that the searchedFaceBoundingBox, contains a face.

Returns:

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

faceMatches

SearchFacesByImageResponse.Builder faceMatches(Collection<FaceMatch> faceMatches)

An array of faces that match the input face, along with the confidence in the match.

Parameters:

faceMatches - An array of faces that match the input face, along with the confidence in the match.

Returns:

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

faceMatches

SearchFacesByImageResponse.Builder faceMatches(FaceMatch... faceMatches)

An array of faces that match the input face, along with the confidence in the match.

Parameters:

faceMatches - An array of faces that match the input face, along with the confidence in the match.

Returns:

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

faceMatches

SearchFacesByImageResponse.Builder faceMatches(Consumer<FaceMatch.Builder>... faceMatches)

An array of faces that match the input face, along with the confidence in the match.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #faceMatches(List).

Parameters:

faceMatches - a consumer that will call methods on FaceMatch.Builder

Returns:

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

See Also:

#faceMatches(java.util.Collection)

faceModelVersion

SearchFacesByImageResponse.Builder faceModelVersion(String faceModelVersion)

Version number of the face detection model associated with the input collection (CollectionId).

Parameters:

faceModelVersion - Version number of the face detection model associated with the input collection ( CollectionId).

Returns:

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