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

Class SearchUsersByImageRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchUsersByImageRequest.Builder,SearchUsersByImageRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchUsersByImageRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SearchUsersByImageRequest.Builder	builder()
String	collectionId()	The ID of an existing collection containing the UserID.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Image	image()	Returns the value of the Image property for this object.
Integer	maxUsers()	Maximum number of UserIDs to return.
QualityFilter	qualityFilter()	A filter that specifies a quality bar for how much filtering is done to identify faces.
String	qualityFilterAsString()	A filter that specifies a quality bar for how much filtering is done to identify faces.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchUsersByImageRequest.Builder>	serializableBuilderClass()
SearchUsersByImageRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Float	userMatchThreshold()	Specifies the minimum confidence in the UserID match to return.

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

The ID of an existing collection containing the UserID.

Returns:

The ID of an existing collection containing the UserID.

image

public final Image image()

Returns the value of the Image property for this object.

Returns:

The value of the Image property for this object.

userMatchThreshold

public final Float userMatchThreshold()

Specifies the minimum confidence in the UserID match to return. Default value is 80.

Returns:

Specifies the minimum confidence in the UserID match to return. Default value is 80.

maxUsers

public final Integer maxUsers()

Maximum number of UserIDs to return.

Returns:

Maximum number of UserIDs to return.

qualityFilter

public final QualityFilter qualityFilter()

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

If the service returns an enum value that is not available in the current SDK version, qualityFilter will return QualityFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from qualityFilterAsString().

Returns:

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

See Also:

QualityFilter

qualityFilterAsString

public final String qualityFilterAsString()

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

If the service returns an enum value that is not available in the current SDK version, qualityFilter will return QualityFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from qualityFilterAsString().

Returns:

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

See Also:

QualityFilter

toBuilder

public SearchUsersByImageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchUsersByImageRequest.Builder,SearchUsersByImageRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static SearchUsersByImageRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo