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)
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()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, 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.

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

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.

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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<CompareFacesRequest.Builder,CompareFacesRequest>

Specified by:

toBuilder in class RekognitionRequest

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()

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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo