software.amazon.awssdk.services.rekognition.model

Interface IndexFacesResponse.Builder

All Superinterfaces:

CopyableBuilder<IndexFacesResponse.Builder,IndexFacesResponse>, RekognitionResponse.Builder, SdkBuilder<IndexFacesResponse.Builder,IndexFacesResponse>

Enclosing class:

IndexFacesResponse

public static interface IndexFacesResponse.Builder
extends RekognitionResponse.Builder, CopyableBuilder<IndexFacesResponse.Builder,IndexFacesResponse>

Method Summary

Modifier and Type	Method and Description
IndexFacesResponse.Builder	faceRecords(Collection<FaceRecord> faceRecords) An array of faces detected and added to the collection.
IndexFacesResponse.Builder	faceRecords(Consumer<FaceRecord.Builder>... faceRecords) An array of faces detected and added to the collection.
IndexFacesResponse.Builder	faceRecords(FaceRecord... faceRecords) An array of faces detected and added to the collection.
IndexFacesResponse.Builder	orientationCorrection(OrientationCorrection orientationCorrection) The orientation of the input image (counterclockwise direction).
IndexFacesResponse.Builder	orientationCorrection(String orientationCorrection) The orientation of the input image (counterclockwise direction).

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

build

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

sdkHttpResponse, sdkHttpResponse

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

copy

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

apply, build

Method Detail

faceRecords

IndexFacesResponse.Builder faceRecords(Collection<FaceRecord> faceRecords)

An array of faces detected and added to the collection. For more information, see howitworks-index-faces.

Parameters:

faceRecords - An array of faces detected and added to the collection. For more information, see howitworks-index-faces.

Returns:

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

faceRecords

IndexFacesResponse.Builder faceRecords(FaceRecord... faceRecords)

An array of faces detected and added to the collection. For more information, see howitworks-index-faces.

Parameters:

faceRecords - An array of faces detected and added to the collection. For more information, see howitworks-index-faces.

Returns:

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

faceRecords

IndexFacesResponse.Builder faceRecords(Consumer<FaceRecord.Builder>... faceRecords)

An array of faces detected and added to the collection. For more information, see howitworks-index-faces.

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 #faceRecords(List).

Parameters:

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

#faceRecords(List)

orientationCorrection

IndexFacesResponse.Builder orientationCorrection(String orientationCorrection)

The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct image orientation. The bounding box coordinates returned in FaceRecords represent face locations before the image orientation is corrected.

If the input image is in jpeg format, it might contain exchangeable image (Exif) metadata. If so, and the Exif metadata populates the orientation field, the value of OrientationCorrection is null and the bounding box coordinates in FaceRecords represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Parameters:

orientationCorrection - The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct image orientation. The bounding box coordinates returned in FaceRecords represent face locations before the image orientation is corrected.

If the input image is in jpeg format, it might contain exchangeable image (Exif) metadata. If so, and the Exif metadata populates the orientation field, the value of OrientationCorrection is null and the bounding box coordinates in FaceRecords represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Returns:

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

See Also:

OrientationCorrection, OrientationCorrection

orientationCorrection

IndexFacesResponse.Builder orientationCorrection(OrientationCorrection orientationCorrection)

The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct image orientation. The bounding box coordinates returned in FaceRecords represent face locations before the image orientation is corrected.

If the input image is in jpeg format, it might contain exchangeable image (Exif) metadata. If so, and the Exif metadata populates the orientation field, the value of OrientationCorrection is null and the bounding box coordinates in FaceRecords represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Parameters:

orientationCorrection - The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct image orientation. The bounding box coordinates returned in FaceRecords represent face locations before the image orientation is corrected.

If the input image is in jpeg format, it might contain exchangeable image (Exif) metadata. If so, and the Exif metadata populates the orientation field, the value of OrientationCorrection is null and the bounding box coordinates in FaceRecords represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Returns:

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

See Also:

OrientationCorrection, OrientationCorrection