Class DetectFacesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DetectFacesRequest.Builder,
DetectFacesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionAn array of facial attributes you want to be returned.An array of facial attributes you want to be returned.static DetectFacesRequest.Builder
builder()
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 extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final Image
image()
The input image as base64-encoded bytes or an S3 object.static Class
<? extends DetectFacesRequest.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
image
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the
Bytes
field. For more information, see Images in the Amazon Rekognition developer guide.- Returns:
- The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon
Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the
Bytes
field. For more information, see Images in the Amazon Rekognition developer guide.
-
attributes
An array of facial attributes you want to be returned. A
DEFAULT
subset of facial attributes -BoundingBox
,Confidence
,Pose
,Quality
, andLandmarks
- will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"
] or just ["FACE_OCCLUDED"
]. You can request for all facial attributes by using ["ALL"]
. Requesting more attributes may increase response time.If you provide both,
["ALL", "DEFAULT"]
, the service uses a logical "AND" operator to determine which attributes to return (in this case, all attributes).Note that while the FaceOccluded and EyeDirection attributes are supported when using
DetectFaces
, they aren't supported when analyzing videos withStartFaceDetection
andGetFaceDetection
.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
hasAttributes()
method.- Returns:
- An array of facial attributes you want to be returned. A
DEFAULT
subset of facial attributes -BoundingBox
,Confidence
,Pose
,Quality
, andLandmarks
- will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"
] or just ["FACE_OCCLUDED"
]. You can request for all facial attributes by using ["ALL"]
. Requesting more attributes may increase response time.If you provide both,
["ALL", "DEFAULT"]
, the service uses a logical "AND" operator to determine which attributes to return (in this case, all attributes).Note that while the FaceOccluded and EyeDirection attributes are supported when using
DetectFaces
, they aren't supported when analyzing videos withStartFaceDetection
andGetFaceDetection
.
-
hasAttributes
public final boolean hasAttributes()For responses, this returns true if the service returned a value for the Attributes 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. -
attributesAsStrings
An array of facial attributes you want to be returned. A
DEFAULT
subset of facial attributes -BoundingBox
,Confidence
,Pose
,Quality
, andLandmarks
- will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"
] or just ["FACE_OCCLUDED"
]. You can request for all facial attributes by using ["ALL"]
. Requesting more attributes may increase response time.If you provide both,
["ALL", "DEFAULT"]
, the service uses a logical "AND" operator to determine which attributes to return (in this case, all attributes).Note that while the FaceOccluded and EyeDirection attributes are supported when using
DetectFaces
, they aren't supported when analyzing videos withStartFaceDetection
andGetFaceDetection
.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
hasAttributes()
method.- Returns:
- An array of facial attributes you want to be returned. A
DEFAULT
subset of facial attributes -BoundingBox
,Confidence
,Pose
,Quality
, andLandmarks
- will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"
] or just ["FACE_OCCLUDED"
]. You can request for all facial attributes by using ["ALL"]
. Requesting more attributes may increase response time.If you provide both,
["ALL", "DEFAULT"]
, the service uses a logical "AND" operator to determine which attributes to return (in this case, all attributes).Note that while the FaceOccluded and EyeDirection attributes are supported when using
DetectFaces
, they aren't supported when analyzing videos withStartFaceDetection
andGetFaceDetection
.
-
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<DetectFacesRequest.Builder,
DetectFacesRequest> - Specified by:
toBuilder
in classRekognitionRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-