software.amazon.awssdk.services.rekognition.model

Interface CompareFacesRequest.Builder

All Superinterfaces:

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

Enclosing class:

CompareFacesRequest

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

Method Summary

Modifier and Type	Method and Description
CompareFacesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CompareFacesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CompareFacesRequest.Builder	similarityThreshold(Float similarityThreshold) The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.
default CompareFacesRequest.Builder	sourceImage(Consumer<Image.Builder> sourceImage) The input image as base64-encoded bytes or an S3 object.
CompareFacesRequest.Builder	sourceImage(Image sourceImage) The input image as base64-encoded bytes or an S3 object.
default CompareFacesRequest.Builder	targetImage(Consumer<Image.Builder> targetImage) The target image as base64-encoded bytes or an S3 object.
CompareFacesRequest.Builder	targetImage(Image targetImage) The target image as base64-encoded bytes or an S3 object.

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

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

sourceImage

CompareFacesRequest.Builder sourceImage(Image sourceImage)

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.

Parameters:

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

Returns:

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

sourceImage

default CompareFacesRequest.Builder sourceImage(Consumer<Image.Builder> sourceImage)

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.

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 sourceImage(Image).

Parameters:

sourceImage - 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:

sourceImage(Image)

targetImage

CompareFacesRequest.Builder targetImage(Image targetImage)

The target 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.

Parameters:

targetImage - The target 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.

Returns:

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

targetImage

default CompareFacesRequest.Builder targetImage(Consumer<Image.Builder> targetImage)

The target 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.

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 targetImage(Image).

Parameters:

targetImage - 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:

targetImage(Image)

similarityThreshold

CompareFacesRequest.Builder similarityThreshold(Float similarityThreshold)

The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Parameters:

similarityThreshold - The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Returns:

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

overrideConfiguration

CompareFacesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.