@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetFaceSearchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
GetFaceSearchResult() |
Modifier and Type | Method and Description |
---|---|
GetFaceSearchResult |
clone() |
boolean |
equals(Object obj) |
String |
getJobId()
Job identifier for the face search operation for which you want to obtain results.
|
String |
getJobStatus()
The current status of the face search job.
|
String |
getJobTag()
A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to
your Amazon Simple Notification Service topic.
|
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. |
Video |
getVideo() |
VideoMetadata |
getVideoMetadata()
Information about a video that Amazon Rekognition analyzed.
|
int |
hashCode() |
void |
setJobId(String jobId)
Job identifier for the face search operation for which you want to obtain results.
|
void |
setJobStatus(String jobStatus)
The current status of the face search job.
|
void |
setJobTag(String jobTag)
A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to
your Amazon Simple Notification Service topic.
|
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 |
setVideo(Video video) |
void |
setVideoMetadata(VideoMetadata videoMetadata)
Information about a video that Amazon Rekognition analyzed.
|
String |
toString()
Returns a string representation of this object.
|
GetFaceSearchResult |
withJobId(String jobId)
Job identifier for the face search operation for which you want to obtain results.
|
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 |
withJobTag(String jobTag)
A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to
your Amazon Simple Notification Service topic.
|
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 |
withVideo(Video video) |
GetFaceSearchResult |
withVideoMetadata(VideoMetadata videoMetadata)
Information about a video that Amazon Rekognition analyzed.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setJobStatus(String jobStatus)
The current status of the face search job.
jobStatus
- The current status of the face search job.VideoJobStatus
public String getJobStatus()
The current status of the face search job.
VideoJobStatus
public GetFaceSearchResult withJobStatus(String jobStatus)
The current status of the face search job.
jobStatus
- The current status of the face search job.VideoJobStatus
public GetFaceSearchResult withJobStatus(VideoJobStatus jobStatus)
The current status of the face search job.
jobStatus
- The current status of the face search job.VideoJobStatus
public void setStatusMessage(String statusMessage)
If the job fails, StatusMessage
provides a descriptive error message.
statusMessage
- If the job fails, StatusMessage
provides a descriptive error message.public String getStatusMessage()
If the job fails, StatusMessage
provides a descriptive error message.
StatusMessage
provides a descriptive error message.public GetFaceSearchResult withStatusMessage(String statusMessage)
If the job fails, StatusMessage
provides a descriptive error message.
statusMessage
- If the job fails, StatusMessage
provides a descriptive error message.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.
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.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.
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.
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.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.
videoMetadata
- Information about a video that Amazon Rekognition analyzed. Videometadata
is returned in
every page of paginated responses from a Amazon Rekognition Video operation.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.
Videometadata
is returned in
every page of paginated responses from a Amazon Rekognition Video operation.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.
videoMetadata
- Information about a video that Amazon Rekognition analyzed. Videometadata
is returned in
every page of paginated responses from a Amazon Rekognition Video operation.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.
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.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.
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.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.
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.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.
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.public void setJobId(String jobId)
Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.
jobId
- Job identifier for the face search operation for which you want to obtain results. The job identifer is
returned by an initial call to StartFaceSearch.public String getJobId()
Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.
public GetFaceSearchResult withJobId(String jobId)
Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.
jobId
- Job identifier for the face search operation for which you want to obtain results. The job identifer is
returned by an initial call to StartFaceSearch.public void setVideo(Video video)
video
- public Video getVideo()
public GetFaceSearchResult withVideo(Video video)
video
- public void setJobTag(String jobTag)
A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
jobTag
- A job identifier specified in the call to StartFaceSearch and returned in the job completion notification
sent to your Amazon Simple Notification Service topic.public String getJobTag()
A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
public GetFaceSearchResult withJobTag(String jobTag)
A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
jobTag
- A job identifier specified in the call to StartFaceSearch and returned in the job completion notification
sent to your Amazon Simple Notification Service topic.public String toString()
toString
in class Object
Object.toString()
public GetFaceSearchResult clone()