com.amazonaws.services.rekognition.model

Class CompareFacesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.CompareFacesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CompareFacesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CompareFacesRequest()

Method Summary

Modifier and Type	Method and Description
CompareFacesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Float	getSimilarityThreshold() The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.
Image	getSourceImage() The input image as base64-encoded bytes or an S3 object.
Image	getTargetImage() The target image as base64-encoded bytes or an S3 object.
int	hashCode()
void	setSimilarityThreshold(Float similarityThreshold) The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.
void	setSourceImage(Image sourceImage) The input image as base64-encoded bytes or an S3 object.
void	setTargetImage(Image targetImage) The target image as base64-encoded bytes or an S3 object.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CompareFacesRequest	withSimilarityThreshold(Float similarityThreshold) The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.
CompareFacesRequest	withSourceImage(Image sourceImage) The input image as base64-encoded bytes or an S3 object.
CompareFacesRequest	withTargetImage(Image targetImage) The target image as base64-encoded bytes or an S3 object.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CompareFacesRequest

public CompareFacesRequest()

Method Detail

setSourceImage

public void setSourceImage(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.

Parameters:

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.

getSourceImage

public Image getSourceImage()

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.

withSourceImage

public CompareFacesRequest withSourceImage(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTargetImage

public void setTargetImage(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.

Parameters:

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.

getTargetImage

public Image getTargetImage()

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.

withTargetImage

public CompareFacesRequest withTargetImage(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSimilarityThreshold

public void setSimilarityThreshold(Float similarityThreshold)

The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Parameters:

similarityThreshold - The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

getSimilarityThreshold

public Float getSimilarityThreshold()

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.

withSimilarityThreshold

public CompareFacesRequest withSimilarityThreshold(Float similarityThreshold)

The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Parameters:

similarityThreshold - The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CompareFacesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()