com.amazonaws.services.rekognition.model

Class GetFaceSearchResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.rekognition.model.GetFaceSearchResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetFaceSearchResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetFaceSearchResult()

Method Summary

Modifier and Type	Method and Description
GetFaceSearchResult	clone()
boolean	equals(Object obj)
String	getJobStatus() The current status of the face search job.
String	getNextToken() If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
List<PersonMatch>	getPersons() An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection.
String	getStatusMessage() If the job fails, StatusMessage provides a descriptive error message.
VideoMetadata	getVideoMetadata() Information about a video that Amazon Rekognition analyzed.
int	hashCode()
void	setJobStatus(String jobStatus) The current status of the face search job.
void	setNextToken(String nextToken) If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
void	setPersons(Collection<PersonMatch> persons) An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection.
void	setStatusMessage(String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
void	setVideoMetadata(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition analyzed.
String	toString() Returns a string representation of this object.
GetFaceSearchResult	withJobStatus(String jobStatus) The current status of the face search job.
GetFaceSearchResult	withJobStatus(VideoJobStatus jobStatus) The current status of the face search job.
GetFaceSearchResult	withNextToken(String nextToken) If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
GetFaceSearchResult	withPersons(Collection<PersonMatch> persons) An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection.
GetFaceSearchResult	withPersons(PersonMatch... persons) An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection.
GetFaceSearchResult	withStatusMessage(String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
GetFaceSearchResult	withVideoMetadata(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition analyzed.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetFaceSearchResult

public GetFaceSearchResult()

Method Detail

setJobStatus

public void setJobStatus(String jobStatus)

The current status of the face search job.

Parameters:

jobStatus - The current status of the face search job.

See Also:

VideoJobStatus

getJobStatus

public String getJobStatus()

The current status of the face search job.

Returns:

The current status of the face search job.

See Also:

VideoJobStatus

withJobStatus

public GetFaceSearchResult withJobStatus(String jobStatus)

The current status of the face search job.

Parameters:

jobStatus - The current status of the face search job.

Returns:

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

See Also:

VideoJobStatus

withJobStatus

public GetFaceSearchResult withJobStatus(VideoJobStatus jobStatus)

The current status of the face search job.

Parameters:

jobStatus - The current status of the face search job.

Returns:

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

See Also:

VideoJobStatus

setStatusMessage

public void setStatusMessage(String statusMessage)

If the job fails, StatusMessage provides a descriptive error message.

Parameters:

statusMessage - If the job fails, StatusMessage provides a descriptive error message.

getStatusMessage

public String getStatusMessage()

If the job fails, StatusMessage provides a descriptive error message.

Returns:

If the job fails, StatusMessage provides a descriptive error message.

withStatusMessage

public GetFaceSearchResult withStatusMessage(String statusMessage)

If the job fails, StatusMessage provides a descriptive error message.

Parameters:

statusMessage - If the job fails, StatusMessage provides a descriptive error message.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

Parameters:

nextToken - If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

getNextToken

public String getNextToken()

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

Returns:

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

withNextToken

public GetFaceSearchResult withNextToken(String nextToken)

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

Parameters:

nextToken - If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

Returns:

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

setVideoMetadata

public void setVideoMetadata(VideoMetadata videoMetadata)

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

Parameters:

videoMetadata - Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

getVideoMetadata

public VideoMetadata getVideoMetadata()

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

Returns:

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

withVideoMetadata

public GetFaceSearchResult withVideoMetadata(VideoMetadata videoMetadata)

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

Parameters:

videoMetadata - Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

Returns:

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

getPersons

public List<PersonMatch> getPersons()

An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

Returns:

An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details ( FaceMatches) for matching faces in the collection, and person information ( Person) for the matched person.

setPersons

public void setPersons(Collection<PersonMatch> persons)

An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

Parameters:

persons - An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

withPersons

public GetFaceSearchResult withPersons(PersonMatch... persons)

An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

NOTE: This method appends the values to the existing list (if any). Use setPersons(java.util.Collection) or withPersons(java.util.Collection) if you want to override the existing values.

Parameters:

persons - An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

Returns:

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

withPersons

public GetFaceSearchResult withPersons(Collection<PersonMatch> persons)

An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

Parameters:

persons - An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

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 GetFaceSearchResult clone()

Overrides:

clone in class Object