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 TypeMethodDescriptioncollectionId
(String collectionId) ID of the collection the face belongs to.ID of a face to find matches for in the collection.faceMatchThreshold
(Float faceMatchThreshold) Optional value specifying the minimum confidence in the face match to return.Maximum number of faces to return.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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, sdkFields
-
Method Details
-
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
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
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
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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SearchFacesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-