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

1#[derive(
2    Debug,
3    Clone,
4    conjure_object::serde::Serialize,
5    conjure_object::serde::Deserialize,
6    PartialEq,
7    Eq,
8    PartialOrd,
9    Ord,
10    Hash
11)]
12#[serde(crate = "conjure_object::serde")]
13#[conjure_object::private::staged_builder::staged_builder]
14#[builder(crate = conjure_object::private::staged_builder, update, inline)]
15pub struct SearchVideosRequest {
16    #[builder(custom(type = super::SearchVideosQuery, convert = Box::new))]
17    #[serde(rename = "query")]
18    query: Box<super::SearchVideosQuery>,
19    #[builder(default, into)]
20    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none", default)]
21    page_size: Option<i32>,
22    #[builder(default, into)]
23    #[serde(rename = "token", skip_serializing_if = "Option::is_none", default)]
24    token: Option<super::super::super::super::api::Token>,
25    #[builder(custom(type = super::SortOptions, convert = Box::new))]
26    #[serde(rename = "sortOptions")]
27    sort_options: Box<super::SortOptions>,
28    #[builder(default, into)]
29    #[serde(
30        rename = "archivedStatuses",
31        skip_serializing_if = "Option::is_none",
32        default
33    )]
34    archived_statuses: Option<
35        std::collections::BTreeSet<super::super::super::super::api::ArchivedStatus>,
36    >,
37}
38impl SearchVideosRequest {
39    /// Constructs a new instance of the type.
40    #[inline]
41    pub fn new(
42        query: super::SearchVideosQuery,
43        sort_options: super::SortOptions,
44    ) -> Self {
45        Self::builder().query(query).sort_options(sort_options).build()
46    }
47    #[inline]
48    pub fn query(&self) -> &super::SearchVideosQuery {
49        &*self.query
50    }
51    /// Defaults to 100. Will throw if larger than 1_000.
52    #[inline]
53    pub fn page_size(&self) -> Option<i32> {
54        self.page_size.as_ref().map(|o| *o)
55    }
56    #[inline]
57    pub fn token(&self) -> Option<&super::super::super::super::api::Token> {
58        self.token.as_ref().map(|o| &*o)
59    }
60    #[inline]
61    pub fn sort_options(&self) -> &super::SortOptions {
62        &*self.sort_options
63    }
64    /// Default search status is NOT_ARCHIVED if none are provided. Allows for including archived videos in search.
65    #[inline]
66    pub fn archived_statuses(
67        &self,
68    ) -> Option<
69        &std::collections::BTreeSet<super::super::super::super::api::ArchivedStatus>,
70    > {
71        self.archived_statuses.as_ref().map(|o| &*o)
72    }
73}
nominal_api/conjure/objects/scout/video/api/search_videos_request.rs

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