StartFaceSearchRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rekognition.model.StartFaceSearchRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartFaceSearchRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier ( JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartFaceSearchRequest()

Constructors
Constructor and Description
`StartFaceSearchRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientRequestToken()` Idempotent token used to identify the start request.
`java.lang.String`	`getCollectionId()` ID of the collection that contains the faces you want to search for.
`java.lang.Float`	`getFaceMatchThreshold()` The minimum confidence in the person match to return.
`java.lang.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(java.lang.String clientRequestToken)` Idempotent token used to identify the start request.
`void`	`setCollectionId(java.lang.String collectionId)` ID of the collection that contains the faces you want to search for.
`void`	`setFaceMatchThreshold(java.lang.Float faceMatchThreshold)` The minimum confidence in the person match to return.
`void`	`setJobTag(java.lang.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.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartFaceSearchRequest`	`withClientRequestToken(java.lang.String clientRequestToken)` Idempotent token used to identify the start request.
`StartFaceSearchRequest`	`withCollectionId(java.lang.String collectionId)` ID of the collection that contains the faces you want to search for.
`StartFaceSearchRequest`	`withFaceMatchThreshold(java.lang.Float faceMatchThreshold)` The minimum confidence in the person match to return.
`StartFaceSearchRequest`	`withJobTag(java.lang.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
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartFaceSearchRequest
```
public StartFaceSearchRequest()
```
- Method Detail
  - 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.
  - 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.
  - withVideo
```
public StartFaceSearchRequest withVideo(Video video)
```
    The video you want to search. The video must be stored in an Amazon S3 bucket.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    video -
    The video you want to search. The video must be stored in an Amazon S3 bucket.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientRequestToken
```
public java.lang.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.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    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.
  - setClientRequestToken
```
public void setClientRequestToken(java.lang.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.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    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.
  - withClientRequestToken
```
public StartFaceSearchRequest withClientRequestToken(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getFaceMatchThreshold
```
public java.lang.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%.
    
    Constraints:
    Length: 0 - 100
    
    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%.
  - setFaceMatchThreshold
```
public void setFaceMatchThreshold(java.lang.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%.
    
    Constraints:
    Length: 0 - 100
    
    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%.
  - withFaceMatchThreshold
```
public StartFaceSearchRequest withFaceMatchThreshold(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 100
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getCollectionId
```
public java.lang.String getCollectionId()
```
    ID of the collection that contains the faces you want to search for.
    
    Constraints:
    Length: 1 - 255
    Pattern: [a-zA-Z0-9_.\-]+
    
    Returns:
    
    ID of the collection that contains the faces you want to search for.
  - setCollectionId
```
public void setCollectionId(java.lang.String collectionId)
```
    ID of the collection that contains the faces you want to search for.
    
    Constraints:
    Length: 1 - 255
    Pattern: [a-zA-Z0-9_.\-]+
    
    Parameters:
    
    collectionId -
    ID of the collection that contains the faces you want to search for.
  - withCollectionId
```
public StartFaceSearchRequest withCollectionId(java.lang.String collectionId)
```
    ID of the collection that contains the faces you want to search for.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 255
    Pattern: [a-zA-Z0-9_.\-]+
    
    Parameters:
    
    collectionId -
    ID of the collection that contains the faces you want to search for.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
    
    Returns:
    
    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
  - 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.
    
    Parameters:
    
    notificationChannel -
    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    notificationChannel -
    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobTag
```
public java.lang.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.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.\-:]+
    
    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.
  - setJobTag
```
public void setJobTag(java.lang.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.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.\-:]+
    
    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.
  - withJobTag
```
public StartFaceSearchRequest withJobTag(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.\-:]+
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class StartFaceSearchRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartFaceSearchRequest

Method Detail

getVideo

setVideo

withVideo

getClientRequestToken

setClientRequestToken

withClientRequestToken

getFaceMatchThreshold

setFaceMatchThreshold

withFaceMatchThreshold

getCollectionId

setCollectionId

withCollectionId

getNotificationChannel

setNotificationChannel

withNotificationChannel

getJobTag

setJobTag

withJobTag

toString

hashCode

equals