Struct aws_sdk_kinesisvideoarchivedmedia::operation::get_images::builders::GetImagesFluentBuilder

pub struct GetImagesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetImages.

Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

Implementations

impl GetImagesFluentBuilder

pub fn as_input(&self) -> &GetImagesInputBuilder

Access the GetImages as a reference.

pub async fn send( self ) -> Result<GetImagesOutput, SdkError<GetImagesError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub async fn customize( self ) -> Result<CustomizableOperation<GetImagesOutput, GetImagesError, Self>, SdkError<GetImagesError>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> GetImagesPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

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

The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

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

The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

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

The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

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

The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

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

The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

pub fn image_selector_type(self, input: ImageSelectorType) -> Self

The origin of the Server or Producer timestamps to use to generate the images.

pub fn set_image_selector_type(self, input: Option<ImageSelectorType>) -> Self

The origin of the Server or Producer timestamps to use to generate the images.

pub fn get_image_selector_type(&self) -> &Option<ImageSelectorType>

The origin of the Server or Producer timestamps to use to generate the images.

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

The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.

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

The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.

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

The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.

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

The end timestamp for the range of images to be generated. If the time range between StartTimestamp and EndTimestamp is more than 300 seconds above StartTimestamp, you will receive an IllegalArgumentException.

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

The end timestamp for the range of images to be generated. If the time range between StartTimestamp and EndTimestamp is more than 300 seconds above StartTimestamp, you will receive an IllegalArgumentException.

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

The end timestamp for the range of images to be generated. If the time range between StartTimestamp and EndTimestamp is more than 300 seconds above StartTimestamp, you will receive an IllegalArgumentException.

pub fn sampling_interval(self, input: i32) -> Self

The time interval in milliseconds (ms) at which the images need to be generated from the stream, with a default of 3000 ms. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available.

The minimum value of 200 ms is a hard limit.

pub fn set_sampling_interval(self, input: Option<i32>) -> Self

The time interval in milliseconds (ms) at which the images need to be generated from the stream, with a default of 3000 ms. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available.

The minimum value of 200 ms is a hard limit.

pub fn get_sampling_interval(&self) -> &Option<i32>

The time interval in milliseconds (ms) at which the images need to be generated from the stream, with a default of 3000 ms. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available.

The minimum value of 200 ms is a hard limit.

pub fn format(self, input: Format) -> Self

The format that will be used to encode the image.

pub fn set_format(self, input: Option<Format>) -> Self

The format that will be used to encode the image.

pub fn get_format(&self) -> &Option<Format>

The format that will be used to encode the image.

pub fn format_config(self, k: FormatConfigKey, v: impl Into<String>) -> Self

Adds a key-value pair to FormatConfig.

To override the contents of this collection use set_format_config.

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

pub fn set_format_config( self, input: Option<HashMap<FormatConfigKey, String>> ) -> Self

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

pub fn get_format_config(&self) -> &Option<HashMap<FormatConfigKey, String>>

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

pub fn width_pixels(self, input: i32) -> Self

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown. If neither parameter is provided, the original image size from the stream will be returned.

pub fn set_width_pixels(self, input: Option<i32>) -> Self

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown. If neither parameter is provided, the original image size from the stream will be returned.

pub fn get_width_pixels(&self) -> &Option<i32>

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown. If neither parameter is provided, the original image size from the stream will be returned.

pub fn height_pixels(self, input: i32) -> Self

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

pub fn set_height_pixels(self, input: Option<i32>) -> Self

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

pub fn get_height_pixels(&self) -> &Option<i32>

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

pub fn max_results(self, input: i64) -> Self

The maximum number of images to be returned by the API.

The default limit is 25 images per API response. Providing a MaxResults greater than this value will result in a page size of 25. Any additional results will be paginated.

pub fn set_max_results(self, input: Option<i64>) -> Self

The maximum number of images to be returned by the API.

The default limit is 25 images per API response. Providing a MaxResults greater than this value will result in a page size of 25. Any additional results will be paginated.

pub fn get_max_results(&self) -> &Option<i64>

The maximum number of images to be returned by the API.

The default limit is 25 images per API response. Providing a MaxResults greater than this value will result in a page size of 25. Any additional results will be paginated.

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

A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

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

A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

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

A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

Trait Implementations

impl Clone for GetImagesFluentBuilder

fn clone(&self) -> GetImagesFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetImagesFluentBuilder

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

Formats the value using the given formatter.