Package software.amazon.awssdk.services.rekognition.model

Class SearchFacesByImageRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rekognition.model.SearchFacesByImageRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<SearchFacesByImageRequest.Builder,SearchFacesByImageRequest>

@Generated("software.amazon.awssdk:codegen")
public class SearchFacesByImageRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<SearchFacesByImageRequest.Builder,SearchFacesByImageRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchFacesByImageRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static SearchFacesByImageRequest.Builder	builder()
String	collectionId()	ID of the collection to search.
boolean	equals(Object obj)
Float	faceMatchThreshold()	(Optional) Specifies the minimum confidence in the face match to return.
int	hashCode()
Image	image()	The input image as bytes or an S3 object.
Integer	maxFaces()	Maximum number of faces to return.
static Class<? extends SearchFacesByImageRequest.Builder>	serializableBuilderClass()
SearchFacesByImageRequest.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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

collectionId

public String collectionId()

ID of the collection to search.

Returns:

ID of the collection to search.

image

public Image image()

The input image as bytes or an S3 object.

Returns:

The input image as bytes or an S3 object.

maxFaces

public Integer maxFaces()

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Returns:

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

faceMatchThreshold

public Float faceMatchThreshold()

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

Returns:

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

toBuilder

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

Returns:

a builder for type T

builder

public static SearchFacesByImageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchFacesByImageRequest.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