software.amazon.awssdk.services.rekognition.model

Interface SearchFacesByImageRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchFacesByImageRequest

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

Method Summary

Modifier and Type	Method and Description
SearchFacesByImageRequest.Builder	collectionId(String collectionId) ID of the collection to search.
SearchFacesByImageRequest.Builder	faceMatchThreshold(Float faceMatchThreshold) (Optional) Specifies the minimum confidence in the face match to return.
default SearchFacesByImageRequest.Builder	image(Consumer<Image.Builder> image) The input image as base64-encoded bytes or an S3 object.
SearchFacesByImageRequest.Builder	image(Image image) The input image as base64-encoded bytes or an S3 object.
SearchFacesByImageRequest.Builder	maxFaces(Integer maxFaces) Maximum number of faces to return.
SearchFacesByImageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SearchFacesByImageRequest.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

SearchFacesByImageRequest.Builder collectionId(String collectionId)

ID of the collection to search.

Parameters:

collectionId - ID of the collection to search.

Returns:

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

image

SearchFacesByImageRequest.Builder image(Image image)

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Parameters:

image - The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:

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

image

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

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

This is a convenience 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)

maxFaces

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

SearchFacesByImageRequest.Builder faceMatchThreshold(Float faceMatchThreshold)

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

Parameters:

faceMatchThreshold - (Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

Returns:

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

overrideConfiguration

SearchFacesByImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder