com.amazonaws.services.rekognition.model

Class IndexFacesResult

java.lang.Object

com.amazonaws.services.rekognition.model.IndexFacesResult

All Implemented Interfaces:

java.io.Serializable

public class IndexFacesResult
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IndexFacesResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getFaceModelVersion() The version number of the face detection model that's associated with the input collection (CollectionId).
java.util.List<FaceRecord>	getFaceRecords() An array of faces detected and added to the collection.
java.lang.String	getOrientationCorrection() If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.
java.util.List<UnindexedFace>	getUnindexedFaces() An array of faces that were detected in the image but weren't indexed.
int	hashCode()
void	setFaceModelVersion(java.lang.String faceModelVersion) The version number of the face detection model that's associated with the input collection (CollectionId).
void	setFaceRecords(java.util.Collection<FaceRecord> faceRecords) An array of faces detected and added to the collection.
void	setOrientationCorrection(OrientationCorrection orientationCorrection) If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.
void	setOrientationCorrection(java.lang.String orientationCorrection) If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.
void	setUnindexedFaces(java.util.Collection<UnindexedFace> unindexedFaces) An array of faces that were detected in the image but weren't indexed.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
IndexFacesResult	withFaceModelVersion(java.lang.String faceModelVersion) The version number of the face detection model that's associated with the input collection (CollectionId).
IndexFacesResult	withFaceRecords(java.util.Collection<FaceRecord> faceRecords) An array of faces detected and added to the collection.
IndexFacesResult	withFaceRecords(FaceRecord... faceRecords) An array of faces detected and added to the collection.
IndexFacesResult	withOrientationCorrection(OrientationCorrection orientationCorrection) If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.
IndexFacesResult	withOrientationCorrection(java.lang.String orientationCorrection) If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.
IndexFacesResult	withUnindexedFaces(java.util.Collection<UnindexedFace> unindexedFaces) An array of faces that were detected in the image but weren't indexed.
IndexFacesResult	withUnindexedFaces(UnindexedFace... unindexedFaces) An array of faces that were detected in the image but weren't indexed.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexFacesResult

public IndexFacesResult()

Method Detail

getFaceRecords

public java.util.List<FaceRecord> getFaceRecords()

An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

Returns:

An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

setFaceRecords

public void setFaceRecords(java.util.Collection<FaceRecord> faceRecords)

An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

Parameters:

faceRecords -

An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

withFaceRecords

public IndexFacesResult withFaceRecords(FaceRecord... faceRecords)

An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

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

Parameters:

faceRecords -

An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

Returns:

A reference to this updated object so that method calls can be chained together.

withFaceRecords

public IndexFacesResult withFaceRecords(java.util.Collection<FaceRecord> faceRecords)

An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

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

Parameters:

faceRecords -

An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getOrientationCorrection

public java.lang.String getOrientationCorrection()

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• 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. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Returns:

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• 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. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

See Also:

OrientationCorrection

setOrientationCorrection

public void setOrientationCorrection(java.lang.String orientationCorrection)

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• 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. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

orientationCorrection -

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• 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. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

See Also:

OrientationCorrection

withOrientationCorrection

public IndexFacesResult withOrientationCorrection(java.lang.String orientationCorrection)

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• 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. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

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

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

orientationCorrection -

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• 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. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OrientationCorrection

setOrientationCorrection

public void setOrientationCorrection(OrientationCorrection orientationCorrection)

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• 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. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

orientationCorrection -

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• 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. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

See Also:

OrientationCorrection

withOrientationCorrection

public IndexFacesResult withOrientationCorrection(OrientationCorrection orientationCorrection)

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• 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. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

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

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

orientationCorrection -

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• 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. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OrientationCorrection

getFaceModelVersion

public java.lang.String getFaceModelVersion()

The version number of the face detection model that's associated with the input collection (CollectionId).

Returns:

The version number of the face detection model that's associated with the input collection (CollectionId).

setFaceModelVersion

public void setFaceModelVersion(java.lang.String faceModelVersion)

The version number of the face detection model that's associated with the input collection (CollectionId).

Parameters:

faceModelVersion -

The version number of the face detection model that's associated with the input collection ( CollectionId).

withFaceModelVersion

public IndexFacesResult withFaceModelVersion(java.lang.String faceModelVersion)

The version number of the face detection model that's associated with the input collection (CollectionId).

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

Parameters:

faceModelVersion -

The version number of the face detection model that's associated with the input collection ( CollectionId).

Returns:

A reference to this updated object so that method calls can be chained together.

getUnindexedFaces

public java.util.List<UnindexedFace> getUnindexedFaces()

An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

Returns:

An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

setUnindexedFaces

public void setUnindexedFaces(java.util.Collection<UnindexedFace> unindexedFaces)

An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

Parameters:

unindexedFaces -

An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

withUnindexedFaces

public IndexFacesResult withUnindexedFaces(UnindexedFace... unindexedFaces)

An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

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

Parameters:

unindexedFaces -

An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

Returns:

A reference to this updated object so that method calls can be chained together.

withUnindexedFaces

public IndexFacesResult withUnindexedFaces(java.util.Collection<UnindexedFace> unindexedFaces)

An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

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

Parameters:

unindexedFaces -

An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object