@Generated(value="software.amazon.awssdk:codegen") public final class CompareFacesRequest extends RekognitionRequest implements ToCopyableBuilder<CompareFacesRequest.Builder,CompareFacesRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CompareFacesRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CompareFacesRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
QualityFilter |
qualityFilter()
A filter that specifies a quality bar for how much filtering is done to identify faces.
|
String |
qualityFilterAsString()
A filter that specifies a quality bar for how much filtering is done to identify faces.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CompareFacesRequest.Builder> |
serializableBuilderClass() |
Float |
similarityThreshold()
The minimum level of confidence in the face matches that a match must meet to be included in the
FaceMatches array. |
Image |
sourceImage()
The input image as base64-encoded bytes or an S3 object.
|
Image |
targetImage()
The target image as base64-encoded bytes or an S3 object.
|
CompareFacesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final Image 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.
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.
public final Image 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.
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.
public final Float similarityThreshold()
The minimum level of confidence in the face matches that a match must meet to be included in the
FaceMatches array.
FaceMatches array.public final QualityFilter 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 specify
LOW, MEDIUM, or HIGH, 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 specify NONE, no filtering is performed. The
default value is NONE.
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 return QualityFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
qualityFilterAsString().
AUTO, Amazon Rekognition chooses the quality bar. If you
specify LOW, MEDIUM, or HIGH, 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 specify
NONE, no filtering is performed. The default value is NONE.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
QualityFilterpublic final String 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 specify
LOW, MEDIUM, or HIGH, 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 specify NONE, no filtering is performed. The
default value is NONE.
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 return QualityFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
qualityFilterAsString().
AUTO, Amazon Rekognition chooses the quality bar. If you
specify LOW, MEDIUM, or HIGH, 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 specify
NONE, no filtering is performed. The default value is NONE.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
QualityFilterpublic CompareFacesRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CompareFacesRequest.Builder,CompareFacesRequest>toBuilder in class RekognitionRequestpublic static CompareFacesRequest.Builder builder()
public static Class<? extends CompareFacesRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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 SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.