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

Class SearchFacesRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rekognition.model.SearchFacesRequest

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchFacesRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static SearchFacesRequest.Builder	builder()
String	collectionId()	ID of the collection the face belongs to.
boolean	equals(Object obj)
String	faceId()	ID of a face to find matches for in the collection.
Float	faceMatchThreshold()	Optional value specifying the minimum confidence in the face match to return.
int	hashCode()
Integer	maxFaces()	Maximum number of faces to return.
static Class<? extends SearchFacesRequest.Builder>	serializableBuilderClass()
SearchFacesRequest.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 the face belongs to.

Returns:

ID of the collection the face belongs to.

faceId

public String faceId()

ID of a face to find matches for in the collection.

Returns:

ID of a face to find matches for in the collection.

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 value specifying 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 value specifying 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 SearchFacesRequest.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<SearchFacesRequest.Builder,SearchFacesRequest>

Returns:

a builder for type T

builder

public static SearchFacesRequest.Builder builder()

serializableBuilderClass

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