nominal-api 0.1240.0

API bindings for the Nominal platform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash
)]
#[serde(crate = "conjure_object::serde")]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct SearchVideosRequest {
    #[builder(custom(type = super::SearchVideosQuery, convert = Box::new))]
    #[serde(rename = "query")]
    query: Box<super::SearchVideosQuery>,
    #[builder(default, into)]
    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none", default)]
    page_size: Option<i32>,
    #[builder(default, into)]
    #[serde(rename = "token", skip_serializing_if = "Option::is_none", default)]
    token: Option<super::super::super::super::api::Token>,
    #[builder(custom(type = super::SortOptions, convert = Box::new))]
    #[serde(rename = "sortOptions")]
    sort_options: Box<super::SortOptions>,
    #[builder(default, into)]
    #[serde(
        rename = "archivedStatuses",
        skip_serializing_if = "Option::is_none",
        default
    )]
    archived_statuses: Option<
        std::collections::BTreeSet<super::super::super::super::api::ArchivedStatus>,
    >,
}
impl SearchVideosRequest {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        query: super::SearchVideosQuery,
        sort_options: super::SortOptions,
    ) -> Self {
        Self::builder().query(query).sort_options(sort_options).build()
    }
    #[inline]
    pub fn query(&self) -> &super::SearchVideosQuery {
        &*self.query
    }
    /// Defaults to 100. Will throw if larger than 1_000.
    #[inline]
    pub fn page_size(&self) -> Option<i32> {
        self.page_size.as_ref().map(|o| *o)
    }
    #[inline]
    pub fn token(&self) -> Option<&super::super::super::super::api::Token> {
        self.token.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn sort_options(&self) -> &super::SortOptions {
        &*self.sort_options
    }
    /// Default search status is NOT_ARCHIVED if none are provided. Allows for including archived videos in search.
    #[inline]
    pub fn archived_statuses(
        &self,
    ) -> Option<
        &std::collections::BTreeSet<super::super::super::super::api::ArchivedStatus>,
    > {
        self.archived_statuses.as_ref().map(|o| &*o)
    }
}