com.amazonaws.services.rekognition.model

Class StartFaceSearchRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.StartFaceSearchRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartFaceSearchRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartFaceSearchRequest()

Method Summary

Modifier and Type	Method and Description
StartFaceSearchRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() Idempotent token used to identify the start request.
String	getCollectionId() ID of the collection that contains the faces you want to search for.
Float	getFaceMatchThreshold() The minimum confidence in the person match to return.
String	getJobTag() An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
NotificationChannel	getNotificationChannel() The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
Video	getVideo() The video you want to search.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) Idempotent token used to identify the start request.
void	setCollectionId(String collectionId) ID of the collection that contains the faces you want to search for.
void	setFaceMatchThreshold(Float faceMatchThreshold) The minimum confidence in the person match to return.
void	setJobTag(String jobTag) An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
void	setNotificationChannel(NotificationChannel notificationChannel) The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
void	setVideo(Video video) The video you want to search.
String	toString() Returns a string representation of this object.
StartFaceSearchRequest	withClientRequestToken(String clientRequestToken) Idempotent token used to identify the start request.
StartFaceSearchRequest	withCollectionId(String collectionId) ID of the collection that contains the faces you want to search for.
StartFaceSearchRequest	withFaceMatchThreshold(Float faceMatchThreshold) The minimum confidence in the person match to return.
StartFaceSearchRequest	withJobTag(String jobTag) An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
StartFaceSearchRequest	withNotificationChannel(NotificationChannel notificationChannel) The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
StartFaceSearchRequest	withVideo(Video video) The video you want to search.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartFaceSearchRequest

public StartFaceSearchRequest()

Method Detail

setVideo

public void setVideo(Video video)

The video you want to search. The video must be stored in an Amazon S3 bucket.

Parameters:

video - The video you want to search. The video must be stored in an Amazon S3 bucket.

getVideo

public Video getVideo()

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.

withVideo

public StartFaceSearchRequest withVideo(Video video)

The video you want to search. The video must be stored in an Amazon S3 bucket.

Parameters:

video - The video you want to search. 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.

setClientRequestToken

public void setClientRequestToken(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.

Parameters:

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.

getClientRequestToken

public String getClientRequestToken()

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.

withClientRequestToken

public StartFaceSearchRequest withClientRequestToken(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.

Parameters:

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:

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

setFaceMatchThreshold

public void setFaceMatchThreshold(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%.

Parameters:

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

getFaceMatchThreshold

public Float getFaceMatchThreshold()

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

withFaceMatchThreshold

public StartFaceSearchRequest withFaceMatchThreshold(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%.

Parameters:

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:

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

setCollectionId

public void setCollectionId(String collectionId)

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

Parameters:

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

getCollectionId

public String getCollectionId()

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.

withCollectionId

public StartFaceSearchRequest withCollectionId(String collectionId)

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

Parameters:

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

Returns:

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

setNotificationChannel

public void setNotificationChannel(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.

Parameters:

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.

getNotificationChannel

public NotificationChannel getNotificationChannel()

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.

withNotificationChannel

public StartFaceSearchRequest withNotificationChannel(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.

Parameters:

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:

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

setJobTag

public void setJobTag(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.

getJobTag

public String getJobTag()

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.

withJobTag

public StartFaceSearchRequest withJobTag(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartFaceSearchRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()