Class RecognizeCelebritiesResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RecognizeCelebritiesResponse.Builder,
RecognizeCelebritiesResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Details about each celebrity found in the image.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the CelebrityFaces property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the UnrecognizedFaces property.final OrientationCorrection
final String
static Class
<? extends RecognizeCelebritiesResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<ComparedFace> Details about each unrecognized face in the image.Methods inherited from class software.amazon.awssdk.services.rekognition.model.RekognitionResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasCelebrityFaces
public final boolean hasCelebrityFaces()For responses, this returns true if the service returned a value for the CelebrityFaces property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
celebrityFaces
Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image. Each celebrity object includes the following attributes:
Face
,Confidence
,Emotions
,Landmarks
,Pose
,Quality
,Smile
,Id
,KnownGender
,MatchConfidence
,Name
,Urls
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCelebrityFaces()
method.- Returns:
- Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64
celebrities in an image. Each celebrity object includes the following attributes:
Face
,Confidence
,Emotions
,Landmarks
,Pose
,Quality
,Smile
,Id
,KnownGender
,MatchConfidence
,Name
,Urls
.
-
hasUnrecognizedFaces
public final boolean hasUnrecognizedFaces()For responses, this returns true if the service returned a value for the UnrecognizedFaces property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
unrecognizedFaces
Details about each unrecognized face in the image.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUnrecognizedFaces()
method.- Returns:
- Details about each unrecognized face in the image.
-
orientationCorrection
Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.
The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in
CelebrityFaces
andUnrecognizedFaces
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. TheCelebrityFaces
andUnrecognizedFaces
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 returnOrientationCorrection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromorientationCorrectionAsString()
.- Returns:
Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.
The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in
CelebrityFaces
andUnrecognizedFaces
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. TheCelebrityFaces
andUnrecognizedFaces
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:
-
orientationCorrectionAsString
Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.
The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in
CelebrityFaces
andUnrecognizedFaces
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. TheCelebrityFaces
andUnrecognizedFaces
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 returnOrientationCorrection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromorientationCorrectionAsString()
.- Returns:
Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.
The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in
CelebrityFaces
andUnrecognizedFaces
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. TheCelebrityFaces
andUnrecognizedFaces
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:
-
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 interfaceToCopyableBuilder<RecognizeCelebritiesResponse.Builder,
RecognizeCelebritiesResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-
sdkFields
-