@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetFaceDetectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
GetFaceDetectionResult() |
Modifier and Type | Method and Description |
---|---|
GetFaceDetectionResult |
clone() |
boolean |
equals(Object obj) |
List<FaceDetection> |
getFaces()
An array of faces detected in the video.
|
String |
getJobId()
Job identifier for the face detection operation for which you want to obtain results.
|
String |
getJobStatus()
The current status of the face detection job.
|
String |
getJobTag()
A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent
to your Amazon Simple Notification Service topic.
|
String |
getNextToken()
If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to
retrieve the next set of faces.
|
String |
getStatusMessage()
If the job fails,
StatusMessage provides a descriptive error message. |
Video |
getVideo() |
VideoMetadata |
getVideoMetadata()
Information about a video that Amazon Rekognition Video analyzed.
|
int |
hashCode() |
void |
setFaces(Collection<FaceDetection> faces)
An array of faces detected in the video.
|
void |
setJobId(String jobId)
Job identifier for the face detection operation for which you want to obtain results.
|
void |
setJobStatus(String jobStatus)
The current status of the face detection job.
|
void |
setJobTag(String jobTag)
A job identifier specified in the call to StartFaceDetection 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 returns this token that you can use in the subsequent request to
retrieve the next set of faces.
|
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 Video analyzed.
|
String |
toString()
Returns a string representation of this object.
|
GetFaceDetectionResult |
withFaces(Collection<FaceDetection> faces)
An array of faces detected in the video.
|
GetFaceDetectionResult |
withFaces(FaceDetection... faces)
An array of faces detected in the video.
|
GetFaceDetectionResult |
withJobId(String jobId)
Job identifier for the face detection operation for which you want to obtain results.
|
GetFaceDetectionResult |
withJobStatus(String jobStatus)
The current status of the face detection job.
|
GetFaceDetectionResult |
withJobStatus(VideoJobStatus jobStatus)
The current status of the face detection job.
|
GetFaceDetectionResult |
withJobTag(String jobTag)
A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent
to your Amazon Simple Notification Service topic.
|
GetFaceDetectionResult |
withNextToken(String nextToken)
If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to
retrieve the next set of faces.
|
GetFaceDetectionResult |
withStatusMessage(String statusMessage)
If the job fails,
StatusMessage provides a descriptive error message. |
GetFaceDetectionResult |
withVideo(Video video) |
GetFaceDetectionResult |
withVideoMetadata(VideoMetadata videoMetadata)
Information about a video that Amazon Rekognition Video analyzed.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setJobStatus(String jobStatus)
The current status of the face detection job.
jobStatus
- The current status of the face detection job.VideoJobStatus
public String getJobStatus()
The current status of the face detection job.
VideoJobStatus
public GetFaceDetectionResult withJobStatus(String jobStatus)
The current status of the face detection job.
jobStatus
- The current status of the face detection job.VideoJobStatus
public GetFaceDetectionResult withJobStatus(VideoJobStatus jobStatus)
The current status of the face detection job.
jobStatus
- The current status of the face detection 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 GetFaceDetectionResult 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 setVideoMetadata(VideoMetadata videoMetadata)
Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned in every
page of paginated responses from a Amazon Rekognition video operation.
videoMetadata
- Information about a video that Amazon Rekognition Video 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 Video 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 GetFaceDetectionResult withVideoMetadata(VideoMetadata videoMetadata)
Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned in every
page of paginated responses from a Amazon Rekognition video operation.
videoMetadata
- Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned
in every page of paginated responses from a Amazon Rekognition video operation.public void setNextToken(String nextToken)
If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
nextToken
- If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent
request to retrieve the next set of faces.public String getNextToken()
If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
public GetFaceDetectionResult withNextToken(String nextToken)
If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
nextToken
- If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent
request to retrieve the next set of faces.public List<FaceDetection> getFaces()
An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
public void setFaces(Collection<FaceDetection> faces)
An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
faces
- An array of faces detected in the video. Each element contains a detected face's details and the time, in
milliseconds from the start of the video, the face was detected.public GetFaceDetectionResult withFaces(FaceDetection... faces)
An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
NOTE: This method appends the values to the existing list (if any). Use
setFaces(java.util.Collection)
or withFaces(java.util.Collection)
if you want to override the
existing values.
faces
- An array of faces detected in the video. Each element contains a detected face's details and the time, in
milliseconds from the start of the video, the face was detected.public GetFaceDetectionResult withFaces(Collection<FaceDetection> faces)
An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
faces
- An array of faces detected in the video. Each element contains a detected face's details and the time, in
milliseconds from the start of the video, the face was detected.public void setJobId(String jobId)
Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.
jobId
- Job identifier for the face detection operation for which you want to obtain results. The job identifer is
returned by an initial call to StartFaceDetection.public String getJobId()
Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.
public GetFaceDetectionResult withJobId(String jobId)
Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.
jobId
- Job identifier for the face detection operation for which you want to obtain results. The job identifer is
returned by an initial call to StartFaceDetection.public void setVideo(Video video)
video
- public Video getVideo()
public GetFaceDetectionResult withVideo(Video video)
video
- public void setJobTag(String jobTag)
A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
jobTag
- A job identifier specified in the call to StartFaceDetection 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 StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
public GetFaceDetectionResult withJobTag(String jobTag)
A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
jobTag
- A job identifier specified in the call to StartFaceDetection 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 GetFaceDetectionResult clone()