com.amazonaws.services.rekognition.model

Class GetFaceDetectionResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.rekognition.model.GetFaceDetectionResult

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetFaceDetectionResult()

Method Summary

Modifier and Type	Method and Description
GetFaceDetectionResult	clone()
boolean	equals(Object obj)
List<FaceDetection>	getFaces() An array of faces detected in the video.
String	getJobStatus() The current status of the face detection job.
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.
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	setJobStatus(String jobStatus) The current status of the face detection job.
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	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	withJobStatus(String jobStatus) The current status of the face detection job.
GetFaceDetectionResult	withJobStatus(VideoJobStatus jobStatus) The current status of the face detection job.
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	withVideoMetadata(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition Video 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

GetFaceDetectionResult

public GetFaceDetectionResult()

Method Detail

setJobStatus

public void setJobStatus(String jobStatus)

The current status of the face detection job.

Parameters:

jobStatus - The current status of the face detection job.

See Also:

VideoJobStatus

getJobStatus

public String getJobStatus()

The current status of the face detection job.

Returns:

The current status of the face detection job.

See Also:

VideoJobStatus

withJobStatus

public GetFaceDetectionResult withJobStatus(String jobStatus)

The current status of the face detection job.

Parameters:

jobStatus - The current status of the face detection job.

Returns:

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

See Also:

VideoJobStatus

withJobStatus

public GetFaceDetectionResult withJobStatus(VideoJobStatus jobStatus)

The current status of the face detection job.

Parameters:

jobStatus - The current status of the face detection 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 GetFaceDetectionResult 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.

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.

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.

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.

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:

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 returns this token that you can use in the subsequent request to retrieve the next set of faces.

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.

getNextToken

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.

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.

withNextToken

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.

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:

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

getFaces

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.

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(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.

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.

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:

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

withFaces

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.

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:

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

Overrides:

clone in class Object