com.amazonaws.services.rekognition.model

Class GetFaceSearchRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.GetFaceSearchRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetFaceSearchRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.

Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier ( JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. 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 Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.

GetFaceSearch only returns the default facial attributes ( BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetFaceSearchRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobId() The job identifer for the search request.
java.lang.Integer	getMaxResults() Maximum number of results to return per paginated call.
java.lang.String	getNextToken() If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response.
java.lang.String	getSortBy() Sort to use for grouping faces in the response.
int	hashCode()
void	setJobId(java.lang.String jobId) The job identifer for the search request.
void	setMaxResults(java.lang.Integer maxResults) Maximum number of results to return per paginated call.
void	setNextToken(java.lang.String nextToken) If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response.
void	setSortBy(FaceSearchSortBy sortBy) Sort to use for grouping faces in the response.
void	setSortBy(java.lang.String sortBy) Sort to use for grouping faces in the response.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetFaceSearchRequest	withJobId(java.lang.String jobId) The job identifer for the search request.
GetFaceSearchRequest	withMaxResults(java.lang.Integer maxResults) Maximum number of results to return per paginated call.
GetFaceSearchRequest	withNextToken(java.lang.String nextToken) If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response.
GetFaceSearchRequest	withSortBy(FaceSearchSortBy sortBy) Sort to use for grouping faces in the response.
GetFaceSearchRequest	withSortBy(java.lang.String sortBy) Sort to use for grouping faces in the response.

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

GetFaceSearchRequest

public GetFaceSearchRequest()

Method Detail

getJobId

public java.lang.String getJobId()

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Returns:

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

setJobId

public void setJobId(java.lang.String jobId)

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

jobId -

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

withJobId

public GetFaceSearchRequest withJobId(java.lang.String jobId)

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

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

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

jobId -

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Constraints:
Range: 1 -

Returns:

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Constraints:
Range: 1 -

Parameters:

maxResults -

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

withMaxResults

public GetFaceSearchRequest withMaxResults(java.lang.Integer maxResults)

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

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

Constraints:
Range: 1 -

Parameters:

maxResults -

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Constraints:
Length: - 255

Returns:

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

setNextToken

public void setNextToken(java.lang.String nextToken)

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Constraints:
Length: - 255

Parameters:

nextToken -

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

withNextToken

public GetFaceSearchRequest withNextToken(java.lang.String nextToken)

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

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

Constraints:
Length: - 255

Parameters:

nextToken -

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Returns:

A reference to this updated object so that method calls can be chained together.

getSortBy

public java.lang.String getSortBy()

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Constraints:
Allowed Values: INDEX, TIMESTAMP

Returns:

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

See Also:

FaceSearchSortBy

setSortBy

public void setSortBy(java.lang.String sortBy)

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Constraints:
Allowed Values: INDEX, TIMESTAMP

Parameters:

sortBy -

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

See Also:

FaceSearchSortBy

withSortBy

public GetFaceSearchRequest withSortBy(java.lang.String sortBy)

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

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

Constraints:
Allowed Values: INDEX, TIMESTAMP

Parameters:

sortBy -

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

FaceSearchSortBy

setSortBy

public void setSortBy(FaceSearchSortBy sortBy)

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Constraints:
Allowed Values: INDEX, TIMESTAMP

Parameters:

sortBy -

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

See Also:

FaceSearchSortBy

withSortBy

public GetFaceSearchRequest withSortBy(FaceSearchSortBy sortBy)

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

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

Constraints:
Allowed Values: INDEX, TIMESTAMP

Parameters:

sortBy -

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

FaceSearchSortBy

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