software.amazon.awssdk.services.rekognition.model

Class GetSegmentDetectionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rekognition.model.RekognitionResponse

software.amazon.awssdk.services.rekognition.model.GetSegmentDetectionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSegmentDetectionResponse.Builder,GetSegmentDetectionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetSegmentDetectionResponse
extends RekognitionResponse
implements ToCopyableBuilder<GetSegmentDetectionResponse.Builder,GetSegmentDetectionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSegmentDetectionResponse.Builder

Method Summary

Modifier and Type	Method and Description
List<AudioMetadata>	audioMetadata() An array of objects.
static GetSegmentDetectionResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAudioMetadata() For responses, this returns true if the service returned a value for the AudioMetadata property.
int	hashCode()
boolean	hasSegments() For responses, this returns true if the service returned a value for the Segments property.
boolean	hasSelectedSegmentTypes() For responses, this returns true if the service returned a value for the SelectedSegmentTypes property.
boolean	hasVideoMetadata() For responses, this returns true if the service returned a value for the VideoMetadata property.
VideoJobStatus	jobStatus() Current status of the segment detection job.
String	jobStatusAsString() Current status of the segment detection job.
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.
List<SdkField<?>>	sdkFields()
List<SegmentDetection>	segments() An array of segments detected in a video.
List<SegmentTypeInfo>	selectedSegmentTypes() An array containing the segment types requested in the call to StartSegmentDetection.
static Class<? extends GetSegmentDetectionResponse.Builder>	serializableBuilderClass()
String	statusMessage() If the job fails, StatusMessage provides a descriptive error message.
GetSegmentDetectionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<VideoMetadata>	videoMetadata() Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array.

Methods inherited from class software.amazon.awssdk.services.rekognition.model.RekognitionResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobStatus

public final VideoJobStatus jobStatus()

Current status of the segment detection job.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return VideoJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

Current status of the segment detection job.

See Also:

VideoJobStatus

jobStatusAsString

public final String jobStatusAsString()

Current status of the segment detection job.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return VideoJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

Current status of the segment detection job.

See Also:

VideoJobStatus

statusMessage

public final String statusMessage()

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

Returns:

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

hasVideoMetadata

public final boolean hasVideoMetadata()

For responses, this returns true if the service returned a value for the VideoMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

videoMetadata

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVideoMetadata() method.

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.

hasAudioMetadata

public final boolean hasAudioMetadata()

For responses, this returns true if the service returned a value for the AudioMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

audioMetadata

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAudioMetadata() method.

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.

nextToken

public final 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:

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.

hasSegments

public final boolean hasSegments()

For responses, this returns true if the service returned a value for the Segments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

segments

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSegments() method.

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.

hasSelectedSegmentTypes

public final boolean hasSelectedSegmentTypes()

For responses, this returns true if the service returned a value for the SelectedSegmentTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

selectedSegmentTypes

public final List<SegmentTypeInfo> selectedSegmentTypes()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSelectedSegmentTypes() method.

Returns:

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

toBuilder

public GetSegmentDetectionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSegmentDetectionResponse.Builder,GetSegmentDetectionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetSegmentDetectionResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetSegmentDetectionResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo