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

Class SearchUsersRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchUsersRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SearchUsersRequest.Builder	builder()
String	collectionId()	The ID of an existing collection containing the UserID, used with a UserId or FaceId.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	faceId()	ID for the existing face.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxUsers()	Maximum number of identities to return.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SearchUsersRequest.Builder>	serializableBuilderClass()
SearchUsersRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	ID for the existing User.
Float	userMatchThreshold()	Optional value that specifies the minimum confidence in the matched UserID 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, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.

Returns:

The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.

userId

public final String userId()

ID for the existing User.

Returns:

ID for the existing User.

faceId

public final String faceId()

ID for the existing face.

Returns:

ID for the existing face.

userMatchThreshold

public final Float userMatchThreshold()

Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.

Returns:

Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.

maxUsers

public final Integer maxUsers()

Maximum number of identities to return.

Returns:

Maximum number of identities to return.

toBuilder

public SearchUsersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static SearchUsersRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo