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() Returns true if the AudioMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasSegments() Returns true if the Segments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSelectedSegmentTypes() Returns true if the SelectedSegmentTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasVideoMetadata() Returns true if the VideoMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 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 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 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 boolean hasVideoMetadata()

Returns true if the VideoMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

videoMetadata

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

You can use hasVideoMetadata() to see if a value was sent in this field.

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 boolean hasAudioMetadata()

Returns true if the AudioMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

audioMetadata

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

You can use hasAudioMetadata() to see if a value was sent in this field.

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 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 boolean hasSegments()

Returns true if the Segments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

segments

public List<SegmentDetection> segments()

An array of segments detected in a video.

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

You can use hasSegments() to see if a value was sent in this field.

Returns:

An array of segments detected in a video.

hasSelectedSegmentTypes

public boolean hasSelectedSegmentTypes()

Returns true if the SelectedSegmentTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

selectedSegmentTypes

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

You can use hasSelectedSegmentTypes() to see if a value was sent in this field.

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 int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo