software.amazon.awssdk.services.rekognition.model

Class DetectFacesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rekognition.model.RekognitionResponse

software.amazon.awssdk.services.rekognition.model.DetectFacesResponse

All Implemented Interfaces:

ToCopyableBuilder<DetectFacesResponse.Builder,DetectFacesResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class DetectFacesResponse
extends RekognitionResponse
implements ToCopyableBuilder<DetectFacesResponse.Builder,DetectFacesResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DetectFacesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DetectFacesResponse.Builder	builder()
boolean	equals(Object obj)
List<FaceDetail>	faceDetails() Details of each face found in the image.
<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 (counter-clockwise direction).
String	orientationCorrectionAsString() The orientation of the input image (counter-clockwise direction).
static Class<? extends DetectFacesResponse.Builder>	serializableBuilderClass()
DetectFacesResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

faceDetails

public List<FaceDetail> faceDetails()

Details of each face found in the image.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Details of each face found in the image.

orientationCorrection

public OrientationCorrection orientationCorrection()

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

If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null and the FaceDetails bounding box coordinates 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 orientationCorrectionAsString().

Returns:

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

If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null and the FaceDetails bounding box coordinates 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

orientationCorrectionAsString

public String orientationCorrectionAsString()

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

If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null and the FaceDetails bounding box coordinates 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 orientationCorrectionAsString().

Returns:

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

If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null and the FaceDetails bounding box coordinates 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

toBuilder

public DetectFacesResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DetectFacesResponse.Builder,DetectFacesResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DetectFacesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DetectFacesResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value