Struct aws_sdk_kinesisvideoarchivedmedia::types::builders::ImageBuilder

#[non_exhaustive]
pub struct ImageBuilder { /* private fields */ }

A builder for Image.

Implementations

impl ImageBuilder

pub fn time_stamp(self, input: DateTime) -> Self

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.

pub fn set_time_stamp(self, input: Option<DateTime>) -> Self

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.

pub fn get_time_stamp(&self) -> &Option<DateTime>

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.

pub fn error(self, input: ImageError) -> Self

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.

pub fn set_error(self, input: Option<ImageError>) -> Self

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.

pub fn get_error(&self) -> &Option<ImageError>

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.

pub fn image_content(self, input: impl Into<String>) -> Self

An attribute of the Image object that is Base64 encoded.

pub fn set_image_content(self, input: Option<String>) -> Self

An attribute of the Image object that is Base64 encoded.

pub fn get_image_content(&self) -> &Option<String>

An attribute of the Image object that is Base64 encoded.

pub fn build(self) -> Image

Consumes the builder and constructs a Image.

Trait Implementations

impl Clone for ImageBuilder

fn clone(&self) -> ImageBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImageBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ImageBuilder

fn default() -> ImageBuilder

Returns the “default value” for a type.

impl PartialEq for ImageBuilder

fn eq(&self, other: &ImageBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ImageBuilder