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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartFaceSearchRequest.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
Float	faceMatchThreshold()	The minimum confidence in the person match to return.
<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 search.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartFaceSearchRequest.Builder>	serializableBuilderClass()
StartFaceSearchRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
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

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 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 final 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 final 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%. The default value is 80%.

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%. The default value is 80%.

collectionId

public final 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 final NotificationChannel notificationChannel()

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

Returns:

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

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 StartFaceSearchRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartFaceSearchRequest.Builder,StartFaceSearchRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static StartFaceSearchRequest.Builder builder()

serializableBuilderClass

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