software.amazon.awssdk.services.rekognition.model

Interface CompareFacesRequest.Builder

All Superinterfaces:

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

Enclosing class:

CompareFacesRequest

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

Method Summary

Modifier and Type	Method and Description
CompareFacesRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
CompareFacesRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.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 source image, either as bytes or as an S3 object.
CompareFacesRequest.Builder	sourceImage(Image sourceImage) The source image, either as bytes or as an S3 object.
default CompareFacesRequest.Builder	targetImage(Consumer<Image.Builder> targetImage) The target image, either as bytes or as an S3 object.
CompareFacesRequest.Builder	targetImage(Image targetImage) The target image, either as bytes or as 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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

sourceImage

CompareFacesRequest.Builder sourceImage(Image sourceImage)

The source image, either as bytes or as an S3 object.

Parameters:

sourceImage - The source image, either as bytes or as an S3 object.

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 source image, either as bytes or as an S3 object.

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, either as bytes or as an S3 object.

Parameters:

targetImage - The target image, either as bytes or as an S3 object.

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, either as bytes or as an S3 object.

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.

requestOverrideConfig

CompareFacesRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

CompareFacesRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.