Skip to main content

nominal_api/conjure/objects/scout/video/api/
create_segments_v2_request.rs

1/// Request to create video segments for channel-based ingestion. Internal use only.
2#[derive(
3    Debug,
4    Clone,
5    conjure_object::serde::Serialize,
6    conjure_object::serde::Deserialize,
7    conjure_object::private::DeriveWith
8)]
9#[serde(crate = "conjure_object::serde")]
10#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
11#[conjure_object::private::staged_builder::staged_builder]
12#[builder(crate = conjure_object::private::staged_builder, update, inline)]
13pub struct CreateSegmentsV2Request {
14    #[serde(rename = "datasetRid")]
15    dataset_rid: super::super::super::super::api::rids::DatasetRid,
16    #[serde(rename = "datasetFileId")]
17    dataset_file_id: conjure_object::Uuid,
18    #[builder(default, list(item(type = super::CreateSegment)))]
19    #[serde(rename = "requests", skip_serializing_if = "Vec::is_empty", default)]
20    requests: Vec<super::CreateSegment>,
21    #[serde(rename = "seriesUuid")]
22    series_uuid: conjure_object::Uuid,
23    #[builder(default, into)]
24    #[serde(
25        rename = "overWriteSegments",
26        skip_serializing_if = "Option::is_none",
27        default
28    )]
29    over_write_segments: Option<bool>,
30}
31impl CreateSegmentsV2Request {
32    /// Constructs a new instance of the type.
33    #[inline]
34    pub fn new(
35        dataset_rid: super::super::super::super::api::rids::DatasetRid,
36        dataset_file_id: conjure_object::Uuid,
37        series_uuid: conjure_object::Uuid,
38    ) -> Self {
39        Self::builder()
40            .dataset_rid(dataset_rid)
41            .dataset_file_id(dataset_file_id)
42            .series_uuid(series_uuid)
43            .build()
44    }
45    #[inline]
46    pub fn dataset_rid(&self) -> &super::super::super::super::api::rids::DatasetRid {
47        &self.dataset_rid
48    }
49    #[inline]
50    pub fn dataset_file_id(&self) -> conjure_object::Uuid {
51        self.dataset_file_id
52    }
53    #[inline]
54    pub fn requests(&self) -> &[super::CreateSegment] {
55        &*self.requests
56    }
57    #[inline]
58    pub fn series_uuid(&self) -> conjure_object::Uuid {
59        self.series_uuid
60    }
61    /// If true, overlapping segments from other dataset files within the same series will be deleted
62    /// before inserting new segments. The cached segment metadata for affected files will be recomputed.
63    #[inline]
64    pub fn over_write_segments(&self) -> Option<bool> {
65        self.over_write_segments.as_ref().map(|o| *o)
66    }
67}