software.amazon.awssdk.services.kinesisvideoarchivedmedia.model

Class Image

java.lang.Object

software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.Image

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Image.Builder,Image>

@Generated(value="software.amazon.awssdk:codegen")
public final class Image
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Image.Builder,Image>

A structure that contains the Timestamp, Error, and ImageContent.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Image.Builder

Method Summary

Modifier and Type	Method and Description
static Image.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ImageError	error() The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error.
String	errorAsString() The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	imageContent() An attribute of the Image object that is Base64 encoded.
List<SdkField<?>>	sdkFields()
static Class<? extends Image.Builder>	serializableBuilderClass()
Instant	timeStamp() An attribute of the Image object that is used to extract an image from the video stream.
Image.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

timeStamp

public final Instant timeStamp()

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

Returns:

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

error

public final ImageError error()

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

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

Returns:

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

See Also:

ImageError

errorAsString

public final String errorAsString()

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

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

Returns:

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

See Also:

ImageError

imageContent

public final String imageContent()

An attribute of the Image object that is Base64 encoded.

Returns:

An attribute of the Image object that is Base64 encoded.

toBuilder

public Image.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Image.Builder,Image>

builder

public static Image.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo