com.amazonaws.services.rekognition.model

Class GetFaceDetectionResult

java.lang.Object

com.amazonaws.services.rekognition.model.GetFaceDetectionResult

All Implemented Interfaces:

java.io.Serializable

public class GetFaceDetectionResult
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetFaceDetectionResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<FaceDetection>	getFaces() An array of faces detected in the video.
java.lang.String	getJobStatus() The current status of the face detection job.
java.lang.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.
java.lang.String	getStatusMessage() If the job fails, StatusMessage provides a descriptive error message.
VideoMetadata	getVideoMetadata() Information about a video that Amazon Rekognition Video analyzed.
int	hashCode()
void	setFaces(java.util.Collection<FaceDetection> faces) An array of faces detected in the video.
void	setJobStatus(java.lang.String jobStatus) The current status of the face detection job.
void	setJobStatus(VideoJobStatus jobStatus) The current status of the face detection job.
void	setNextToken(java.lang.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(java.lang.String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
void	setVideoMetadata(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition Video analyzed.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetFaceDetectionResult	withFaces(java.util.Collection<FaceDetection> faces) An array of faces detected in the video.
GetFaceDetectionResult	withFaces(FaceDetection... faces) An array of faces detected in the video.
GetFaceDetectionResult	withJobStatus(java.lang.String jobStatus) The current status of the face detection job.
GetFaceDetectionResult	withJobStatus(VideoJobStatus jobStatus) The current status of the face detection job.
GetFaceDetectionResult	withNextToken(java.lang.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(java.lang.String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
GetFaceDetectionResult	withVideoMetadata(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition Video analyzed.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetFaceDetectionResult

public GetFaceDetectionResult()

Method Detail

getJobStatus

public java.lang.String getJobStatus()

The current status of the face detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Returns:

The current status of the face detection job.

See Also:

VideoJobStatus

setJobStatus

public void setJobStatus(java.lang.String jobStatus)

The current status of the face detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Parameters:

jobStatus -

The current status of the face detection job.

See Also:

VideoJobStatus

withJobStatus

public GetFaceDetectionResult withJobStatus(java.lang.String jobStatus)

The current status of the face detection job.

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

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Parameters:

jobStatus -

The current status of the face detection job.

Returns:

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

See Also:

VideoJobStatus

setJobStatus

public void setJobStatus(VideoJobStatus jobStatus)

The current status of the face detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Parameters:

jobStatus -

The current status of the face detection job.

See Also:

VideoJobStatus

withJobStatus

public GetFaceDetectionResult withJobStatus(VideoJobStatus jobStatus)

The current status of the face detection job.

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

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Parameters:

jobStatus -

The current status of the face detection job.

Returns:

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

See Also:

VideoJobStatus

getStatusMessage

public java.lang.String getStatusMessage()

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

Returns:

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

setStatusMessage

public void setStatusMessage(java.lang.String statusMessage)

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

Parameters:

statusMessage -

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

withStatusMessage

public GetFaceDetectionResult withStatusMessage(java.lang.String statusMessage)

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

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

Parameters:

statusMessage -

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

Returns:

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

getVideoMetadata

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.

Returns:

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

setVideoMetadata

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.

Parameters:

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.

withVideoMetadata

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.

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

Parameters:

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.

Returns:

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

getNextToken

public java.lang.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.

Constraints:
Length: - 255

Returns:

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.

setNextToken

public void setNextToken(java.lang.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.

Constraints:
Length: - 255

Parameters:

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.

withNextToken

public GetFaceDetectionResult withNextToken(java.lang.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.

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

Constraints:
Length: - 255

Parameters:

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.

Returns:

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

getFaces

public java.util.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.

Returns:

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.

setFaces

public void setFaces(java.util.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.

Parameters:

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.

withFaces

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.

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

Parameters:

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.

Returns:

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

withFaces

public GetFaceDetectionResult withFaces(java.util.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.

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

Parameters:

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.

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