Package software.amazon.awssdk.services.rekognition.model

Interface StartFaceDetectionRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartFaceDetectionRequest

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

Method Summary

Modifier and Type	Method	Description
StartFaceDetectionRequest.Builder	clientRequestToken(String clientRequestToken)	Idempotent token used to identify the start request.
StartFaceDetectionRequest.Builder	faceAttributes(String faceAttributes)	The face attributes you want returned.
StartFaceDetectionRequest.Builder	faceAttributes(FaceAttributes faceAttributes)	The face attributes you want returned.
StartFaceDetectionRequest.Builder	jobTag(String jobTag)	An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
default StartFaceDetectionRequest.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 face detection operation.
StartFaceDetectionRequest.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 face detection operation.
StartFaceDetectionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartFaceDetectionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default StartFaceDetectionRequest.Builder	video(Consumer<Video.Builder> video)	The video in which you want to detect faces.
StartFaceDetectionRequest.Builder	video(Video video)	The video in which you want to detect faces.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

video

StartFaceDetectionRequest.Builder video(Video video)

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

Parameters:

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

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

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

StartFaceDetectionRequest.Builder clientRequestToken(String clientRequestToken)

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

notificationChannel

StartFaceDetectionRequest.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 face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

Parameters:

notificationChannel - The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

Returns:

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

notificationChannel

default StartFaceDetectionRequest.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 face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

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

faceAttributes

StartFaceDetectionRequest.Builder faceAttributes(String faceAttributes)

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

Parameters:

faceAttributes - The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

Returns:

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

See Also:

FaceAttributes, FaceAttributes

faceAttributes

StartFaceDetectionRequest.Builder faceAttributes(FaceAttributes faceAttributes)

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

Parameters:

faceAttributes - The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

Returns:

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

See Also:

FaceAttributes, FaceAttributes

jobTag

StartFaceDetectionRequest.Builder jobTag(String jobTag)

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Parameters:

jobTag - An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Returns:

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

overrideConfiguration

StartFaceDetectionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder