@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class IndexFacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
IndexFacesResult() |
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()
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. |
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)
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(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(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.
|
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)
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(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(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.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
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.
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.
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.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.
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.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.
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.public void setOrientationCorrection(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.
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.
OrientationCorrection
public 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.
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.
OrientationCorrection
public IndexFacesResult withOrientationCorrection(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.
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.
OrientationCorrection
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.
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.
OrientationCorrection
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.
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.
OrientationCorrection
public void setFaceModelVersion(String faceModelVersion)
The version number of the face detection model that's associated with the input collection (
CollectionId
).
faceModelVersion
- The version number of the face detection model that's associated with the input collection (
CollectionId
).public String getFaceModelVersion()
The version number of the face detection model that's associated with the input collection (
CollectionId
).
CollectionId
).public IndexFacesResult withFaceModelVersion(String faceModelVersion)
The version number of the face detection model that's associated with the input collection (
CollectionId
).
faceModelVersion
- The version number of the face detection model that's associated with the input collection (
CollectionId
).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.
MaxFaces
request parameter filtered
them out. To use the quality filter, you specify the QualityFilter
request parameter.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.
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.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.
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.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.
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.public String toString()
toString
in class Object
Object.toString()
public IndexFacesResult clone()