Struct aws_sdk_kinesisvideoarchivedmedia::types::builders::ClipTimestampRangeBuilder

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

A builder for ClipTimestampRange.

Implementations

impl ClipTimestampRangeBuilder

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

The starting timestamp in the range of timestamps for which to return fragments.

Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments that start before StartTimestamp and continue past it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

This field is required.

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

The starting timestamp in the range of timestamps for which to return fragments.

Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments that start before StartTimestamp and continue past it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

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

The starting timestamp in the range of timestamps for which to return fragments.

Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments that start before StartTimestamp and continue past it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

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

The end of the timestamp range for the requested media.

This value must be within 24 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value. If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.

This field is required.

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

The end of the timestamp range for the requested media.

This value must be within 24 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value. If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.

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

The end of the timestamp range for the requested media.

This value must be within 24 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value. If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.

pub fn build(self) -> Result<ClipTimestampRange, BuildError>

Consumes the builder and constructs a ClipTimestampRange. This method will fail if any of the following fields are not set:

• start_timestamp
• end_timestamp

Trait Implementations

impl Clone for ClipTimestampRangeBuilder

fn clone(&self) -> ClipTimestampRangeBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClipTimestampRangeBuilder

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

Formats the value using the given formatter.

impl Default for ClipTimestampRangeBuilder

fn default() -> ClipTimestampRangeBuilder

Returns the “default value” for a type.

impl PartialEq for ClipTimestampRangeBuilder

fn eq(&self, other: &ClipTimestampRangeBuilder) -> 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 ClipTimestampRangeBuilder