software.amazon.awssdk.services.rekognition.model

Interface StartLabelDetectionRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartLabelDetectionRequest

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

Method Summary

Modifier and Type	Method and Description
StartLabelDetectionRequest.Builder	clientRequestToken(String clientRequestToken) Idempotent token used to identify the start request.
StartLabelDetectionRequest.Builder	jobTag(String jobTag) Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
StartLabelDetectionRequest.Builder	minConfidence(Float minConfidence) Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label.
default StartLabelDetectionRequest.Builder	notificationChannel(Consumer<NotificationChannel.Builder> notificationChannel) The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.
StartLabelDetectionRequest.Builder	notificationChannel(NotificationChannel notificationChannel) The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.
StartLabelDetectionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StartLabelDetectionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
default StartLabelDetectionRequest.Builder	video(Consumer<Video.Builder> video) The video in which you want to detect labels.
StartLabelDetectionRequest.Builder	video(Video video) The video in which you want to detect labels.

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

StartLabelDetectionRequest.Builder video(Video video)

The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.

Parameters:

video - The video in which you want to detect labels. 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 StartLabelDetectionRequest.Builder video(Consumer<Video.Builder> video)

The video in which you want to detect labels. 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

StartLabelDetectionRequest.Builder clientRequestToken(String clientRequestToken)

Idempotent token used to identify the start request. If you use the same token with multiple StartLabelDetection 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 StartLabelDetection 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.

minConfidence

StartLabelDetectionRequest.Builder minConfidence(Float minConfidence)

Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

Parameters:

minConfidence - Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

Returns:

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

notificationChannel

StartLabelDetectionRequest.Builder notificationChannel(NotificationChannel notificationChannel)

The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.

Parameters:

notificationChannel - The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.

Returns:

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

notificationChannel

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

The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.

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

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

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

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