Package software.amazon.awssdk.services.kinesisvideoarchivedmedia.model

Class GetImagesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.KinesisVideoArchivedMediaResponse

software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.GetImagesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetImagesResponse.Builder,GetImagesResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetImagesResponse
extends KinesisVideoArchivedMediaResponse
implements ToCopyableBuilder<GetImagesResponse.Builder,GetImagesResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetImagesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetImagesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasImages()	For responses, this returns true if the service returned a value for the Images property.
List<Image>	images()	The list of images generated from the video stream.
String	nextToken()	The encrypted token that was used in the request to get more images.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetImagesResponse.Builder>	serializableBuilderClass()
GetImagesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.KinesisVideoArchivedMediaResponse

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

hasImages

public final boolean hasImages()

For responses, this returns true if the service returned a value for the Images 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.

images

public final List<Image> images()

The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.

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 hasImages() method.

Returns:

The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.

nextToken

public final String nextToken()

The encrypted token that was used in the request to get more images.

Returns:

The encrypted token that was used in the request to get more images.

toBuilder

public GetImagesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetImagesResponse.Builder,GetImagesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetImagesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetImagesResponse.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo