com.amazonaws.services.rekognition.model

Class GetSegmentDetectionResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.rekognition.model.GetSegmentDetectionResult

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetSegmentDetectionResult()

Method Summary

Modifier and Type	Method and Description
GetSegmentDetectionResult	clone()
boolean	equals(Object obj)
List<AudioMetadata>	getAudioMetadata() An array of objects.
String	getJobStatus() Current status of the segment detection job.
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.
List<SegmentDetection>	getSegments() An array of segments detected in a video.
List<SegmentTypeInfo>	getSelectedSegmentTypes() An array containing the segment types requested in the call to StartSegmentDetection.
String	getStatusMessage() If the job fails, StatusMessage provides a descriptive error message.
List<VideoMetadata>	getVideoMetadata() Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array.
int	hashCode()
void	setAudioMetadata(Collection<AudioMetadata> audioMetadata) An array of objects.
void	setJobStatus(String jobStatus) Current status of the segment detection job.
void	setNextToken(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(Collection<SegmentDetection> segments) An array of segments detected in a video.
void	setSelectedSegmentTypes(Collection<SegmentTypeInfo> selectedSegmentTypes) An array containing the segment types requested in the call to StartSegmentDetection.
void	setStatusMessage(String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
void	setVideoMetadata(Collection<VideoMetadata> videoMetadata) Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array.
String	toString() Returns a string representation of this object.
GetSegmentDetectionResult	withAudioMetadata(AudioMetadata... audioMetadata) An array of objects.
GetSegmentDetectionResult	withAudioMetadata(Collection<AudioMetadata> audioMetadata) An array of objects.
GetSegmentDetectionResult	withJobStatus(String jobStatus) Current status of the segment detection job.
GetSegmentDetectionResult	withJobStatus(VideoJobStatus jobStatus) Current status of the segment detection job.
GetSegmentDetectionResult	withNextToken(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(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(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(String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
GetSegmentDetectionResult	withVideoMetadata(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 com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetSegmentDetectionResult

public GetSegmentDetectionResult()

Method Detail

setJobStatus

public void setJobStatus(String jobStatus)

Current status of the segment detection job.

Parameters:

jobStatus - Current status of the segment detection job.

See Also:

VideoJobStatus

getJobStatus

public String getJobStatus()

Current status of the segment detection job.

Returns:

Current status of the segment detection job.

See Also:

VideoJobStatus

withJobStatus

public GetSegmentDetectionResult withJobStatus(String jobStatus)

Current status of the segment detection job.

Parameters:

jobStatus - Current status of the segment detection job.

Returns:

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

See Also:

VideoJobStatus

withJobStatus

public GetSegmentDetectionResult withJobStatus(VideoJobStatus jobStatus)

Current status of the segment detection job.

Parameters:

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

getVideoMetadata

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

NOTE: This method appends the values to the existing list (if any). Use setVideoMetadata(java.util.Collection) or withVideoMetadata(java.util.Collection) if you want to override the existing values.

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:

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

withVideoMetadata

public GetSegmentDetectionResult withVideoMetadata(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.

Returns:

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

getAudioMetadata

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

NOTE: This method appends the values to the existing list (if any). Use setAudioMetadata(java.util.Collection) or withAudioMetadata(java.util.Collection) if you want to override the existing values.

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:

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

withAudioMetadata

public GetSegmentDetectionResult withAudioMetadata(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.

Returns:

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

setNextToken

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

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.

getNextToken

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

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.

withNextToken

public GetSegmentDetectionResult withNextToken(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.

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:

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

getSegments

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

NOTE: This method appends the values to the existing list (if any). Use setSegments(java.util.Collection) or withSegments(java.util.Collection) if you want to override the existing 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.

Returns:

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

withSegments

public GetSegmentDetectionResult withSegments(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.

Returns:

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

getSelectedSegmentTypes

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

NOTE: This method appends the values to the existing list (if any). Use setSelectedSegmentTypes(java.util.Collection) or withSelectedSegmentTypes(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

withSelectedSegmentTypes

public GetSegmentDetectionResult withSelectedSegmentTypes(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.

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

Overrides:

clone in class Object