software.amazon.awssdk.services.rekognition.model

Class StartFaceSearchRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartFaceSearchRequest.Builder,StartFaceSearchRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartFaceSearchRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartFaceSearchRequest.Builder	builder()
String	clientRequestToken() Idempotent token used to identify the start request.
String	collectionId() ID of the collection that contains the faces you want to search for.
boolean	equals(Object obj)
Float	faceMatchThreshold() The minimum confidence in the person match to return.
<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 search.
List<SdkField<?>>	sdkFields()
static Class<? extends StartFaceSearchRequest.Builder>	serializableBuilderClass()
StartFaceSearchRequest.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 you want to search.

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 you want to search. The video must be stored in an Amazon S3 bucket.

Returns:

The video you want to search. 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 StartFaceSearch 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 StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

faceMatchThreshold

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

Returns:

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

collectionId

public String collectionId()

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

Returns:

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

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

Returns:

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

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

Specified by:

toBuilder in class RekognitionRequest

Returns:

a builder for type T

builder

public static StartFaceSearchRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartFaceSearchRequest.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.