software.amazon.awssdk.services.rekognition.model

Class CompareFacesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rekognition.model.RekognitionRequest

software.amazon.awssdk.services.rekognition.model.CompareFacesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CompareFacesRequest.Builder,CompareFacesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CompareFacesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CompareFacesRequest.Builder	builder()
boolean	equals(Object obj)
<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()
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()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

sourceImage

public 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.

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.

targetImage

public 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.

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.

similarityThreshold

public Float 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.

toBuilder

public CompareFacesRequest.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<CompareFacesRequest.Builder,CompareFacesRequest>

Specified by:

toBuilder in class RekognitionRequest

Returns:

a builder for type T

builder

public static CompareFacesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CompareFacesRequest.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: SdkRequest

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

Overrides:

getValueForField in class SdkRequest

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.