software.amazon.awssdk.services.rekognition.model

Interface StartFaceSearchRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartFaceSearchRequest

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

Method Summary

Modifier and Type	Method and Description
StartFaceSearchRequest.Builder	clientRequestToken(String clientRequestToken) Idempotent token used to identify the start request.
StartFaceSearchRequest.Builder	collectionId(String collectionId) ID of the collection that contains the faces you want to search for.
StartFaceSearchRequest.Builder	faceMatchThreshold(Float faceMatchThreshold) The minimum confidence in the person match to return.
StartFaceSearchRequest.Builder	jobTag(String jobTag) Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
default StartFaceSearchRequest.Builder	notificationChannel(Consumer<NotificationChannel.Builder> notificationChannel) The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
StartFaceSearchRequest.Builder	notificationChannel(NotificationChannel notificationChannel) The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
StartFaceSearchRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StartFaceSearchRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
default StartFaceSearchRequest.Builder	video(Consumer<Video.Builder> video) The video you want to search.
StartFaceSearchRequest.Builder	video(Video video) The video you want to search.

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

video

StartFaceSearchRequest.Builder video(Video video)

The video you want to search. The video must be stored in an Amazon S3 bucket.

Parameters:

video - The video you want to search. The video must be stored in an Amazon S3 bucket.

Returns:

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

video

default StartFaceSearchRequest.Builder video(Consumer<Video.Builder> video)

The video you want to search. The video must be stored in an Amazon S3 bucket.

This is a convenience that creates an instance of the Video.Builder avoiding the need to create one manually via Video.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to video(Video).

Parameters:

video - a consumer that will call methods on Video.Builder

Returns:

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

See Also:

video(Video)

clientRequestToken

StartFaceSearchRequest.Builder clientRequestToken(String clientRequestToken)

Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Parameters:

clientRequestToken - Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Returns:

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

faceMatchThreshold

StartFaceSearchRequest.Builder faceMatchThreshold(Float faceMatchThreshold)

The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%.

Parameters:

faceMatchThreshold - The minimum confidence in the person 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.

collectionId

StartFaceSearchRequest.Builder collectionId(String collectionId)

ID of the collection that contains the faces you want to search for.

Parameters:

collectionId - ID of the collection that contains the faces you want to search for.

Returns:

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

notificationChannel

StartFaceSearchRequest.Builder notificationChannel(NotificationChannel notificationChannel)

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.

Parameters:

notificationChannel - The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.

Returns:

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

notificationChannel

default StartFaceSearchRequest.Builder notificationChannel(Consumer<NotificationChannel.Builder> notificationChannel)

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.

This is a convenience that creates an instance of the NotificationChannel.Builder avoiding the need to create one manually via NotificationChannel.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationChannel(NotificationChannel).

Parameters:

notificationChannel - a consumer that will call methods on NotificationChannel.Builder

Returns:

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

See Also:

notificationChannel(NotificationChannel)

jobTag

StartFaceSearchRequest.Builder jobTag(String jobTag)

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

Parameters:

jobTag - Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

Returns:

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

overrideConfiguration

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

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