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

Interface SearchUsersByImageRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchUsersByImageRequest.Builder,SearchUsersByImageRequest>, RekognitionRequest.Builder, SdkBuilder<SearchUsersByImageRequest.Builder,SearchUsersByImageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchUsersByImageRequest

public static interface SearchUsersByImageRequest.Builder
extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<SearchUsersByImageRequest.Builder,SearchUsersByImageRequest>

Method Summary

Modifier and Type	Method	Description
SearchUsersByImageRequest.Builder	collectionId(String collectionId)	The ID of an existing collection containing the UserID.
default SearchUsersByImageRequest.Builder	image(Consumer<Image.Builder> image)	Sets the value of the Image property for this object.
SearchUsersByImageRequest.Builder	image(Image image)	Sets the value of the Image property for this object.
SearchUsersByImageRequest.Builder	maxUsers(Integer maxUsers)	Maximum number of UserIDs to return.
SearchUsersByImageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SearchUsersByImageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SearchUsersByImageRequest.Builder	qualityFilter(String qualityFilter)	A filter that specifies a quality bar for how much filtering is done to identify faces.
SearchUsersByImageRequest.Builder	qualityFilter(QualityFilter qualityFilter)	A filter that specifies a quality bar for how much filtering is done to identify faces.
SearchUsersByImageRequest.Builder	userMatchThreshold(Float userMatchThreshold)	Specifies the minimum confidence in the UserID match to return.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

collectionId

SearchUsersByImageRequest.Builder collectionId(String collectionId)

The ID of an existing collection containing the UserID.

Parameters:

collectionId - The ID of an existing collection containing the UserID.

Returns:

Returns a reference to this object so that method calls can be chained together.

image

SearchUsersByImageRequest.Builder image(Image image)

Sets the value of the Image property for this object.

Parameters:

image - The new value for the Image property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

image

default SearchUsersByImageRequest.Builder image(Consumer<Image.Builder> image)

Sets the value of the Image property for this object. This is a convenience method that creates an instance of the Image.Builder avoiding the need to create one manually via Image.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to image(Image).

Parameters:

image - a consumer that will call methods on Image.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

image(Image)

userMatchThreshold

SearchUsersByImageRequest.Builder userMatchThreshold(Float userMatchThreshold)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

maxUsers

SearchUsersByImageRequest.Builder maxUsers(Integer maxUsers)

Maximum number of UserIDs to return.

Parameters:

maxUsers - Maximum number of UserIDs to return.

Returns:

Returns a reference to this object so that method calls can be chained together.

qualityFilter

SearchUsersByImageRequest.Builder qualityFilter(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QualityFilter, QualityFilter

qualityFilter

SearchUsersByImageRequest.Builder qualityFilter(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QualityFilter, QualityFilter

overrideConfiguration

SearchUsersByImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

SearchUsersByImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder