Class CompareFacesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CompareFacesRequest.Builder,
CompareFacesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CompareFacesRequest.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 int
hashCode()
final QualityFilter
A filter that specifies a quality bar for how much filtering is done to identify faces.final String
A filter that specifies a quality bar for how much filtering is done to identify faces.static Class
<? extends CompareFacesRequest.Builder> final Float
The minimum level of confidence in the face matches that a match must meet to be included in theFaceMatches
array.final Image
The input image as base64-encoded bytes or an S3 object.final Image
The target image as base64-encoded bytes or an S3 object.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
-
sourceImage
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.
-
targetImage
The target 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 target 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.
-
similarityThreshold
The minimum level of confidence in the face matches that a match must meet to be included in the
FaceMatches
array.- Returns:
- The minimum level of confidence in the face matches that a match must meet to be included in the
FaceMatches
array.
-
qualityFilter
A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify
AUTO
, Amazon Rekognition chooses the quality bar. If you specifyLOW
,MEDIUM
, orHIGH
, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specifyNONE
, no filtering is performed. The default value isNONE
.To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
If the service returns an enum value that is not available in the current SDK version,
qualityFilter
will returnQualityFilter.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromqualityFilterAsString()
.- Returns:
- A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces
aren't compared. If you specify
AUTO
, Amazon Rekognition chooses the quality bar. If you specifyLOW
,MEDIUM
, orHIGH
, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specifyNONE
, no filtering is performed. The default value isNONE
.To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
- See Also:
-
qualityFilterAsString
A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify
AUTO
, Amazon Rekognition chooses the quality bar. If you specifyLOW
,MEDIUM
, orHIGH
, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specifyNONE
, no filtering is performed. The default value isNONE
.To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
If the service returns an enum value that is not available in the current SDK version,
qualityFilter
will returnQualityFilter.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromqualityFilterAsString()
.- Returns:
- A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces
aren't compared. If you specify
AUTO
, Amazon Rekognition chooses the quality bar. If you specifyLOW
,MEDIUM
, orHIGH
, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specifyNONE
, no filtering is performed. The default value isNONE
.To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
- 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<CompareFacesRequest.Builder,
CompareFacesRequest> - 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
-