software.amazon.awssdk.services.rekognition.model

Interface SearchFacesRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchFacesRequest

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

Method Summary

Modifier and Type	Method and Description
SearchFacesRequest.Builder	collectionId(String collectionId) ID of the collection the face belongs to.
SearchFacesRequest.Builder	faceId(String faceId) ID of a face to find matches for in the collection.
SearchFacesRequest.Builder	faceMatchThreshold(Float faceMatchThreshold) Optional value specifying the minimum confidence in the face match to return.
SearchFacesRequest.Builder	maxFaces(Integer maxFaces) Maximum number of faces to return.
SearchFacesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SearchFacesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

collectionId

SearchFacesRequest.Builder collectionId(String collectionId)

ID of the collection the face belongs to.

Parameters:

collectionId - ID of the collection the face belongs to.

Returns:

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

faceId

SearchFacesRequest.Builder faceId(String faceId)

ID of a face to find matches for in the collection.

Parameters:

faceId - ID of a face to find matches for in the collection.

Returns:

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

maxFaces

SearchFacesRequest.Builder maxFaces(Integer maxFaces)

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Parameters:

maxFaces - Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Returns:

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

faceMatchThreshold

SearchFacesRequest.Builder faceMatchThreshold(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%.

Parameters:

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:

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

overrideConfiguration

SearchFacesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder