com.amazonaws.services.rekognition.model

Class IndexFacesResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.rekognition.model.IndexFacesResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IndexFacesResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IndexFacesResult()

Method Summary

Modifier and Type	Method and Description
IndexFacesResult	clone()
boolean	equals(Object obj)
String	getFaceModelVersion() The version number of the face detection model that's associated with the input collection ( CollectionId).
List<FaceRecord>	getFaceRecords() An array of faces detected and added to the collection.
String	getOrientationCorrection() The orientation of the input image (counterclockwise direction).
List<UnindexedFace>	getUnindexedFaces() An array of faces that were detected in the image but weren't indexed.
int	hashCode()
void	setFaceModelVersion(String faceModelVersion) The version number of the face detection model that's associated with the input collection ( CollectionId).
void	setFaceRecords(Collection<FaceRecord> faceRecords) An array of faces detected and added to the collection.
void	setOrientationCorrection(OrientationCorrection orientationCorrection) The orientation of the input image (counterclockwise direction).
void	setOrientationCorrection(String orientationCorrection) The orientation of the input image (counterclockwise direction).
void	setUnindexedFaces(Collection<UnindexedFace> unindexedFaces) An array of faces that were detected in the image but weren't indexed.
String	toString() Returns a string representation of this object; useful for testing and debugging.
IndexFacesResult	withFaceModelVersion(String faceModelVersion) The version number of the face detection model that's associated with the input collection ( CollectionId).
IndexFacesResult	withFaceRecords(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) The orientation of the input image (counterclockwise direction).
IndexFacesResult	withOrientationCorrection(String orientationCorrection) The orientation of the input image (counterclockwise direction).
IndexFacesResult	withUnindexedFaces(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 com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexFacesResult

public IndexFacesResult()

Method Detail

getFaceRecords

public 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(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.

NOTE: This method appends the values to the existing list (if any). Use setFaceRecords(java.util.Collection) or withFaceRecords(java.util.Collection) if you want to override the existing values.

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:

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

withFaceRecords

public IndexFacesResult withFaceRecords(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.

Returns:

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

setOrientationCorrection

public void setOrientationCorrection(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. 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. 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.

See Also:

OrientationCorrection

getOrientationCorrection

public String getOrientationCorrection()

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

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. 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.

See Also:

OrientationCorrection

withOrientationCorrection

public IndexFacesResult withOrientationCorrection(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. 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. 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

setOrientationCorrection

public void setOrientationCorrection(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. 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. 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.

See Also:

OrientationCorrection

withOrientationCorrection

public IndexFacesResult withOrientationCorrection(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. 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. 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

setFaceModelVersion

public void setFaceModelVersion(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).

getFaceModelVersion

public 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).

withFaceModelVersion

public IndexFacesResult withFaceModelVersion(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).

Returns:

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

getUnindexedFaces

public 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(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.

NOTE: This method appends the values to the existing list (if any). Use setUnindexedFaces(java.util.Collection) or withUnindexedFaces(java.util.Collection) if you want to override the existing values.

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:

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

withUnindexedFaces

public IndexFacesResult withUnindexedFaces(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.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public IndexFacesResult clone()

Overrides:

clone in class Object