software.amazon.awssdk.services.rekognition.model

Interface CompareFacesResponse.Builder

All Superinterfaces:

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

Enclosing class:

CompareFacesResponse

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

Method Summary

Modifier and Type	Method and Description
CompareFacesResponse.Builder	faceMatches(Collection<CompareFacesMatch> faceMatches) An array of faces in the target image that match the source image face.
CompareFacesResponse.Builder	faceMatches(CompareFacesMatch... faceMatches) An array of faces in the target image that match the source image face.
CompareFacesResponse.Builder	faceMatches(Consumer<CompareFacesMatch.Builder>... faceMatches) An array of faces in the target image that match the source image face.
CompareFacesResponse.Builder	sourceImageFace(ComparedSourceImageFace sourceImageFace) The face in the source image that was used for comparison.
default CompareFacesResponse.Builder	sourceImageFace(Consumer<ComparedSourceImageFace.Builder> sourceImageFace) The face in the source image that was used for comparison.
CompareFacesResponse.Builder	sourceImageOrientationCorrection(OrientationCorrection sourceImageOrientationCorrection) The value of SourceImageOrientationCorrection is always null.
CompareFacesResponse.Builder	sourceImageOrientationCorrection(String sourceImageOrientationCorrection) The value of SourceImageOrientationCorrection is always null.
CompareFacesResponse.Builder	targetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection) The value of TargetImageOrientationCorrection is always null.
CompareFacesResponse.Builder	targetImageOrientationCorrection(String targetImageOrientationCorrection) The value of TargetImageOrientationCorrection is always null.
CompareFacesResponse.Builder	unmatchedFaces(Collection<ComparedFace> unmatchedFaces) An array of faces in the target image that did not match the source image face.
CompareFacesResponse.Builder	unmatchedFaces(ComparedFace... unmatchedFaces) An array of faces in the target image that did not match the source image face.
CompareFacesResponse.Builder	unmatchedFaces(Consumer<ComparedFace.Builder>... unmatchedFaces) An array of faces in the target image that did not match the source image face.

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

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

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

sourceImageFace

CompareFacesResponse.Builder sourceImageFace(ComparedSourceImageFace sourceImageFace)

The face in the source image that was used for comparison.

Parameters:

sourceImageFace - The face in the source image that was used for comparison.

Returns:

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

sourceImageFace

default CompareFacesResponse.Builder sourceImageFace(Consumer<ComparedSourceImageFace.Builder> sourceImageFace)

The face in the source image that was used for comparison.

This is a convenience that creates an instance of the ComparedSourceImageFace.Builder avoiding the need to create one manually via ComparedSourceImageFace.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceImageFace(ComparedSourceImageFace).

Parameters:

sourceImageFace - a consumer that will call methods on ComparedSourceImageFace.Builder

Returns:

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

See Also:

sourceImageFace(ComparedSourceImageFace)

faceMatches

CompareFacesResponse.Builder faceMatches(Collection<CompareFacesMatch> faceMatches)

An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

Parameters:

faceMatches - An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

Returns:

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

faceMatches

CompareFacesResponse.Builder faceMatches(CompareFacesMatch... faceMatches)

An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

Parameters:

faceMatches - An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

Returns:

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

faceMatches

CompareFacesResponse.Builder faceMatches(Consumer<CompareFacesMatch.Builder>... faceMatches)

An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #faceMatches(List).

Parameters:

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

Returns:

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

See Also:

#faceMatches(List)

unmatchedFaces

CompareFacesResponse.Builder unmatchedFaces(Collection<ComparedFace> unmatchedFaces)

An array of faces in the target image that did not match the source image face.

Parameters:

unmatchedFaces - An array of faces in the target image that did not match the source image face.

Returns:

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

unmatchedFaces

CompareFacesResponse.Builder unmatchedFaces(ComparedFace... unmatchedFaces)

An array of faces in the target image that did not match the source image face.

Parameters:

unmatchedFaces - An array of faces in the target image that did not match the source image face.

Returns:

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

unmatchedFaces

CompareFacesResponse.Builder unmatchedFaces(Consumer<ComparedFace.Builder>... unmatchedFaces)

An array of faces in the target image that did not match the source image face.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #unmatchedFaces(List).

Parameters:

unmatchedFaces - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#unmatchedFaces(List)

sourceImageOrientationCorrection

CompareFacesResponse.Builder sourceImageOrientationCorrection(String sourceImageOrientationCorrection)

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Parameters:

sourceImageOrientationCorrection - The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Returns:

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

See Also:

OrientationCorrection, OrientationCorrection

sourceImageOrientationCorrection

CompareFacesResponse.Builder sourceImageOrientationCorrection(OrientationCorrection sourceImageOrientationCorrection)

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Parameters:

sourceImageOrientationCorrection - The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Returns:

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

See Also:

OrientationCorrection, OrientationCorrection

targetImageOrientationCorrection

CompareFacesResponse.Builder targetImageOrientationCorrection(String targetImageOrientationCorrection)

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Parameters:

targetImageOrientationCorrection - The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Returns:

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

See Also:

OrientationCorrection, OrientationCorrection

targetImageOrientationCorrection

CompareFacesResponse.Builder targetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection)

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Parameters:

targetImageOrientationCorrection - The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Returns:

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

See Also:

OrientationCorrection, OrientationCorrection