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

Class FaceSearchSettings

java.lang.Object

software.amazon.awssdk.services.rekognition.model.FaceSearchSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FaceSearchSettings.Builder,FaceSearchSettings>

@Generated("software.amazon.awssdk:codegen")
public final class FaceSearchSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FaceSearchSettings.Builder,FaceSearchSettings>

Input face recognition parameters for an Amazon Rekognition stream processor. Includes the collection to use for face recognition and the face attributes to detect. Defining the settings is required in the request parameter for CreateStreamProcessor.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FaceSearchSettings.Builder

Method Summary

Modifier and Type	Method	Description
static FaceSearchSettings.Builder	builder()
String	collectionId()	The ID of a collection that contains faces that you want to search for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Float	faceMatchThreshold()	Minimum face match confidence score that must be met to return a result for a recognized face.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FaceSearchSettings.Builder>	serializableBuilderClass()
FaceSearchSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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 final String collectionId()

The ID of a collection that contains faces that you want to search for.

Returns:

The ID of a collection that contains faces that you want to search for.

faceMatchThreshold

public final Float faceMatchThreshold()

Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.

Returns:

Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.

toBuilder

public FaceSearchSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FaceSearchSettings.Builder,FaceSearchSettings>

builder

public static FaceSearchSettings.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo