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

Class StartFaceDetectionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rekognition.model.RekognitionRequest

software.amazon.awssdk.services.rekognition.model.StartFaceDetectionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartFaceDetectionRequest.Builder,StartFaceDetectionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartFaceDetectionRequest
extends RekognitionRequest
implements ToCopyableBuilder<StartFaceDetectionRequest.Builder,StartFaceDetectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartFaceDetectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartFaceDetectionRequest.Builder	builder()
String	clientRequestToken()	Idempotent token used to identify the start request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FaceAttributes	faceAttributes()	The face attributes you want returned.
String	faceAttributesAsString()	The face attributes you want returned.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobTag()	An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartFaceDetectionRequest.Builder>	serializableBuilderClass()
StartFaceDetectionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Video	video()	The video in which you want to detect faces.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

video

public final Video video()

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

Returns:

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

clientRequestToken

public final 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.

Returns:

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.

notificationChannel

public final 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.

Returns:

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.

faceAttributes

public final 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.

If the service returns an enum value that is not available in the current SDK version, faceAttributes will return FaceAttributes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from faceAttributesAsString().

Returns:

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.

See Also:

FaceAttributes

faceAttributesAsString

public final String faceAttributesAsString()

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.

If the service returns an enum value that is not available in the current SDK version, faceAttributes will return FaceAttributes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from faceAttributesAsString().

Returns:

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.

See Also:

FaceAttributes

jobTag

public final 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.

Returns:

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.

toBuilder

public StartFaceDetectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartFaceDetectionRequest.Builder,StartFaceDetectionRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static StartFaceDetectionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartFaceDetectionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo