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(value="software.amazon.awssdk:codegen")
public final class StartFaceDetectionRequest
extends RekognitionRequest
implements ToCopyableBuilder<StartFaceDetectionRequest.Builder,StartFaceDetectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartFaceDetectionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartFaceDetectionRequest.Builder	builder()
String	clientRequestToken() Idempotent token used to identify the start request.
boolean	equals(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) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	jobTag() Unique identifier you specify to identify the job in the completion status published to the 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.
List<SdkField<?>>	sdkFields()
static Class<? extends StartFaceDetectionRequest.Builder>	serializableBuilderClass()
StartFaceDetectionRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

video

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

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.

faceAttributes

public 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 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 String jobTag()

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

Returns:

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

toBuilder

public StartFaceDetectionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StartFaceDetectionRequest.Builder,StartFaceDetectionRequest>

Specified by:

toBuilder in class RekognitionRequest

Returns:

a builder for type T

builder

public static StartFaceDetectionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.