com.amazonaws.services.rekognition.model

Class GetSegmentDetectionResult

java.lang.Object

com.amazonaws.services.rekognition.model.GetSegmentDetectionResult

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetSegmentDetectionResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<AudioMetadata>	getAudioMetadata() An array of objects.
java.lang.String	getJobStatus() Current status of the segment detection job.
java.lang.String	getNextToken() If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.
java.util.List<SegmentDetection>	getSegments() An array of segments detected in a video.
java.util.List<SegmentTypeInfo>	getSelectedSegmentTypes() An array containing the segment types requested in the call to StartSegmentDetection.
java.lang.String	getStatusMessage() If the job fails, StatusMessage provides a descriptive error message.
java.util.List<VideoMetadata>	getVideoMetadata() Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array.
int	hashCode()
void	setAudioMetadata(java.util.Collection<AudioMetadata> audioMetadata) An array of objects.
void	setJobStatus(java.lang.String jobStatus) Current status of the segment detection job.
void	setJobStatus(VideoJobStatus jobStatus) Current status of the segment detection job.
void	setNextToken(java.lang.String nextToken) If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.
void	setSegments(java.util.Collection<SegmentDetection> segments) An array of segments detected in a video.
void	setSelectedSegmentTypes(java.util.Collection<SegmentTypeInfo> selectedSegmentTypes) An array containing the segment types requested in the call to StartSegmentDetection.
void	setStatusMessage(java.lang.String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
void	setVideoMetadata(java.util.Collection<VideoMetadata> videoMetadata) Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetSegmentDetectionResult	withAudioMetadata(AudioMetadata... audioMetadata) An array of objects.
GetSegmentDetectionResult	withAudioMetadata(java.util.Collection<AudioMetadata> audioMetadata) An array of objects.
GetSegmentDetectionResult	withJobStatus(java.lang.String jobStatus) Current status of the segment detection job.
GetSegmentDetectionResult	withJobStatus(VideoJobStatus jobStatus) Current status of the segment detection job.
GetSegmentDetectionResult	withNextToken(java.lang.String nextToken) If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.
GetSegmentDetectionResult	withSegments(java.util.Collection<SegmentDetection> segments) An array of segments detected in a video.
GetSegmentDetectionResult	withSegments(SegmentDetection... segments) An array of segments detected in a video.
GetSegmentDetectionResult	withSelectedSegmentTypes(java.util.Collection<SegmentTypeInfo> selectedSegmentTypes) An array containing the segment types requested in the call to StartSegmentDetection.
GetSegmentDetectionResult	withSelectedSegmentTypes(SegmentTypeInfo... selectedSegmentTypes) An array containing the segment types requested in the call to StartSegmentDetection.
GetSegmentDetectionResult	withStatusMessage(java.lang.String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
GetSegmentDetectionResult	withVideoMetadata(java.util.Collection<VideoMetadata> videoMetadata) Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array.
GetSegmentDetectionResult	withVideoMetadata(VideoMetadata... videoMetadata) Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetSegmentDetectionResult

public GetSegmentDetectionResult()

Method Detail

getJobStatus

public java.lang.String getJobStatus()

Current status of the segment detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Returns:

Current status of the segment detection job.

See Also:

VideoJobStatus

setJobStatus

public void setJobStatus(java.lang.String jobStatus)

Current status of the segment detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Parameters:

jobStatus -

Current status of the segment detection job.

See Also:

VideoJobStatus

withJobStatus

public GetSegmentDetectionResult withJobStatus(java.lang.String jobStatus)

Current status of the segment 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 -

Current status of the segment 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)

Current status of the segment detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Parameters:

jobStatus -

Current status of the segment detection job.

See Also:

VideoJobStatus

withJobStatus

public GetSegmentDetectionResult withJobStatus(VideoJobStatus jobStatus)

Current status of the segment 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 -

Current status of the segment 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 GetSegmentDetectionResult 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 java.util.List<VideoMetadata> getVideoMetadata()

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

Returns:

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

setVideoMetadata

public void setVideoMetadata(java.util.Collection<VideoMetadata> videoMetadata)

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

Parameters:

videoMetadata -

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

withVideoMetadata

public GetSegmentDetectionResult withVideoMetadata(VideoMetadata... videoMetadata)

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

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

Parameters:

videoMetadata -

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

Returns:

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

withVideoMetadata

public GetSegmentDetectionResult withVideoMetadata(java.util.Collection<VideoMetadata> videoMetadata)

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

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

Parameters:

videoMetadata -

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

Returns:

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

getAudioMetadata

public java.util.List<AudioMetadata> getAudioMetadata()

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

Returns:

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

setAudioMetadata

public void setAudioMetadata(java.util.Collection<AudioMetadata> audioMetadata)

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

Parameters:

audioMetadata -

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

withAudioMetadata

public GetSegmentDetectionResult withAudioMetadata(AudioMetadata... audioMetadata)

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

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

Parameters:

audioMetadata -

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

Returns:

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

withAudioMetadata

public GetSegmentDetectionResult withAudioMetadata(java.util.Collection<AudioMetadata> audioMetadata)

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

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

Parameters:

audioMetadata -

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

Returns:

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

getNextToken

public java.lang.String getNextToken()

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

Constraints:
Length: - 255

Returns:

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

setNextToken

public void setNextToken(java.lang.String nextToken)

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

Constraints:
Length: - 255

Parameters:

nextToken -

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

withNextToken

public GetSegmentDetectionResult withNextToken(java.lang.String nextToken)

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

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

Constraints:
Length: - 255

Parameters:

nextToken -

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

Returns:

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

getSegments

public java.util.List<SegmentDetection> getSegments()

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

Returns:

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

setSegments

public void setSegments(java.util.Collection<SegmentDetection> segments)

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

Parameters:

segments -

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

withSegments

public GetSegmentDetectionResult withSegments(SegmentDetection... segments)

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

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

Parameters:

segments -

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

Returns:

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

withSegments

public GetSegmentDetectionResult withSegments(java.util.Collection<SegmentDetection> segments)

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

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

Parameters:

segments -

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

Returns:

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

getSelectedSegmentTypes

public java.util.List<SegmentTypeInfo> getSelectedSegmentTypes()

An array containing the segment types requested in the call to StartSegmentDetection.

Returns:

An array containing the segment types requested in the call to StartSegmentDetection.

setSelectedSegmentTypes

public void setSelectedSegmentTypes(java.util.Collection<SegmentTypeInfo> selectedSegmentTypes)

An array containing the segment types requested in the call to StartSegmentDetection.

Parameters:

selectedSegmentTypes -

An array containing the segment types requested in the call to StartSegmentDetection.

withSelectedSegmentTypes

public GetSegmentDetectionResult withSelectedSegmentTypes(SegmentTypeInfo... selectedSegmentTypes)

An array containing the segment types requested in the call to StartSegmentDetection.

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

Parameters:

selectedSegmentTypes -

An array containing the segment types requested in the call to StartSegmentDetection.

Returns:

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

withSelectedSegmentTypes

public GetSegmentDetectionResult withSelectedSegmentTypes(java.util.Collection<SegmentTypeInfo> selectedSegmentTypes)

An array containing the segment types requested in the call to StartSegmentDetection.

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

Parameters:

selectedSegmentTypes -

An array containing the segment types requested in the call to StartSegmentDetection.

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