software.amazon.awssdk.services.rekognition.model

Class SearchFacesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchFacesRequest.Builder,SearchFacesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchFacesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchFacesRequest.Builder	builder()
String	collectionId() ID of the collection the face belongs to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxFaces() Maximum number of faces to return.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchFacesRequest.Builder>	serializableBuilderClass()
SearchFacesRequest.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

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%. The default value is 80%.

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%. The default value is 80%.

toBuilder

public SearchFacesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchFacesRequest.Builder,SearchFacesRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static SearchFacesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchFacesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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