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

Interface Image.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Image.Builder,Image>, SdkBuilder<Image.Builder,Image>, SdkPojo

Enclosing class:

Image

public static interface Image.Builder
extends SdkPojo, CopyableBuilder<Image.Builder,Image>

Method Summary

Modifier and Type	Method	Description
Image.Builder	error(String error)	The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error.
Image.Builder	error(ImageError error)	The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error.
Image.Builder	imageContent(String imageContent)	An attribute of the Image object that is Base64 encoded.
Image.Builder	timeStamp(Instant timeStamp)	An attribute of the Image object that is used to extract an image from the video stream.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

timeStamp

Image.Builder timeStamp(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.

Parameters:

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:

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

error

Image.Builder error(String 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.

Parameters:

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.

Returns:

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

See Also:

• ImageError
• ImageError

error

Image.Builder error(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.

Parameters:

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.

Returns:

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

See Also:

• ImageError
• ImageError

imageContent

Image.Builder imageContent(String imageContent)

An attribute of the Image object that is Base64 encoded.

Parameters:

imageContent - An attribute of the Image object that is Base64 encoded.

Returns:

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