@Generated(value="software.amazon.awssdk:codegen") public class IndexFacesResponse extends RekognitionResponse implements ToCopyableBuilder<IndexFacesResponse.Builder,IndexFacesResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
IndexFacesResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static IndexFacesResponse.Builder |
builder() |
boolean |
equals(Object obj) |
List<FaceRecord> |
faceRecords()
An array of faces detected and added to the collection.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
OrientationCorrection |
orientationCorrection()
The orientation of the input image (counterclockwise direction).
|
String |
orientationCorrectionString()
The orientation of the input image (counterclockwise direction).
|
static Class<? extends IndexFacesResponse.Builder> |
serializableBuilderClass() |
IndexFacesResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public List<FaceRecord> faceRecords()
An array of faces detected and added to the collection. For more information, see howitworks-index-faces.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
If the service returns an enum value that is not available in the current SDK version,
orientationCorrection
will return OrientationCorrection.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from orientationCorrectionString()
.
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.
OrientationCorrection
public String orientationCorrectionString()
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.
If the service returns an enum value that is not available in the current SDK version,
orientationCorrection
will return OrientationCorrection.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from orientationCorrectionString()
.
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.
OrientationCorrection
public IndexFacesResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<IndexFacesResponse.Builder,IndexFacesResponse>
toBuilder
in class AwsResponse
public static IndexFacesResponse.Builder builder()
public static Class<? extends IndexFacesResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.