com.amazonaws.services.rekognition.model

Class GetLabelDetectionResult

java.lang.Object

com.amazonaws.services.rekognition.model.GetLabelDetectionResult

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetLabelDetectionResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobStatus() The current status of the label detection job.
java.lang.String	getLabelModelVersion() Version number of the label detection model that was used to detect labels.
java.util.List<LabelDetection>	getLabels() An array of labels detected in the video.
java.lang.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 labels.
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	setJobStatus(java.lang.String jobStatus) The current status of the label detection job.
void	setJobStatus(VideoJobStatus jobStatus) The current status of the label detection job.
void	setLabelModelVersion(java.lang.String labelModelVersion) Version number of the label detection model that was used to detect labels.
void	setLabels(java.util.Collection<LabelDetection> labels) An array of labels detected in the video.
void	setNextToken(java.lang.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 labels.
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.
GetLabelDetectionResult	withJobStatus(java.lang.String jobStatus) The current status of the label detection job.
GetLabelDetectionResult	withJobStatus(VideoJobStatus jobStatus) The current status of the label detection job.
GetLabelDetectionResult	withLabelModelVersion(java.lang.String labelModelVersion) Version number of the label detection model that was used to detect labels.
GetLabelDetectionResult	withLabels(java.util.Collection<LabelDetection> labels) An array of labels detected in the video.
GetLabelDetectionResult	withLabels(LabelDetection... labels) An array of labels detected in the video.
GetLabelDetectionResult	withNextToken(java.lang.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 labels.
GetLabelDetectionResult	withStatusMessage(java.lang.String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
GetLabelDetectionResult	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

GetLabelDetectionResult

public GetLabelDetectionResult()

Method Detail

getJobStatus

public java.lang.String getJobStatus()

The current status of the label detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Returns:

The current status of the label detection job.

See Also:

VideoJobStatus

setJobStatus

public void setJobStatus(java.lang.String jobStatus)

The current status of the label detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Parameters:

jobStatus -

The current status of the label detection job.

See Also:

VideoJobStatus

withJobStatus

public GetLabelDetectionResult withJobStatus(java.lang.String jobStatus)

The current status of the label 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 label 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 label detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Parameters:

jobStatus -

The current status of the label detection job.

See Also:

VideoJobStatus

withJobStatus

public GetLabelDetectionResult withJobStatus(VideoJobStatus jobStatus)

The current status of the label 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 label 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 GetLabelDetectionResult 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 GetLabelDetectionResult 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 Video returns this token that you can use in the subsequent request to retrieve the next set of labels.

Constraints:
Length: - 255

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

setNextToken

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

Constraints:
Length: - 255

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

withNextToken

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

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

Returns:

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

getLabels

public java.util.List<LabelDetection> getLabels()

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

Returns:

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

setLabels

public void setLabels(java.util.Collection<LabelDetection> labels)

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

Parameters:

labels -

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

withLabels

public GetLabelDetectionResult withLabels(LabelDetection... labels)

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

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

Parameters:

labels -

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

Returns:

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

withLabels

public GetLabelDetectionResult withLabels(java.util.Collection<LabelDetection> labels)

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

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

Parameters:

labels -

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

Returns:

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

getLabelModelVersion

public java.lang.String getLabelModelVersion()

Version number of the label detection model that was used to detect labels.

Returns:

Version number of the label detection model that was used to detect labels.

setLabelModelVersion

public void setLabelModelVersion(java.lang.String labelModelVersion)

Version number of the label detection model that was used to detect labels.

Parameters:

labelModelVersion -

Version number of the label detection model that was used to detect labels.

withLabelModelVersion

public GetLabelDetectionResult withLabelModelVersion(java.lang.String labelModelVersion)

Version number of the label detection model that was used to detect labels.

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

Parameters:

labelModelVersion -

Version number of the label detection model that was used to detect labels.

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