nominal-api 0.1239.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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

/// If both sets are empty, an empty page is returned.
/// If one set is empty, that field is not considered for filtering (like a wildcard).
/// If commitId is omitted from a ChecklistRef, it will match all commits.
#[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 FindDataReviewsRequest {
    #[builder(default, set(item(type = super::super::super::run::api::RunRid)))]
    #[serde(
        rename = "runRids",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    run_rids: std::collections::BTreeSet<super::super::super::run::api::RunRid>,
    #[builder(default, set(item(type = super::super::super::rids::api::AssetRid)))]
    #[serde(
        rename = "assetRids",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    asset_rids: std::collections::BTreeSet<super::super::super::rids::api::AssetRid>,
    #[builder(default, into)]
    #[serde(
        rename = "filterByBothRunsAndAssets",
        skip_serializing_if = "Option::is_none",
        default
    )]
    filter_by_both_runs_and_assets: Option<bool>,
    #[builder(default, set(item(type = super::super::super::checks::api::ChecklistRef)))]
    #[serde(
        rename = "checklistRefs",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    checklist_refs: std::collections::BTreeSet<
        super::super::super::checks::api::ChecklistRef,
    >,
    #[builder(default, into)]
    #[serde(rename = "nextPageToken", skip_serializing_if = "Option::is_none", default)]
    next_page_token: Option<super::super::super::super::api::Token>,
    #[builder(default, into)]
    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none", default)]
    page_size: Option<i32>,
    #[builder(default, into)]
    #[serde(rename = "showArchived", skip_serializing_if = "Option::is_none", default)]
    show_archived: Option<bool>,
    #[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 FindDataReviewsRequest {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new() -> Self {
        Self::builder().build()
    }
    #[inline]
    pub fn run_rids(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::run::api::RunRid> {
        &self.run_rids
    }
    #[inline]
    pub fn asset_rids(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::rids::api::AssetRid> {
        &self.asset_rids
    }
    /// If true, results are filtered to data reviews w/ both run and asset in the requested runs/assets.
    /// Defaults to false, where assets are converted to runs and all data reviews under the linked runs
    /// (including data reviews on other assets sharing the parent run) will be returned.
    /// It is recommended to set this to true and pass in asset RIDs for multi-asset runs.
    /// Toggling this option has no effect if no asset RIDs are supplied.
    #[inline]
    pub fn filter_by_both_runs_and_assets(&self) -> Option<bool> {
        self.filter_by_both_runs_and_assets.as_ref().map(|o| *o)
    }
    #[inline]
    pub fn checklist_refs(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::checks::api::ChecklistRef> {
        &self.checklist_refs
    }
    #[inline]
    pub fn next_page_token(&self) -> Option<&super::super::super::super::api::Token> {
        self.next_page_token.as_ref().map(|o| &*o)
    }
    /// Defaults to 1000. Will throw if larger than 1000.
    #[inline]
    pub fn page_size(&self) -> Option<i32> {
        self.page_size.as_ref().map(|o| *o)
    }
    /// To be deprecated. Use archivedStatuses instead. Allows for inclusion of archived data reviews
    /// in search results alongside non-archived ones. Defaults to false if not specified.
    #[inline]
    pub fn show_archived(&self) -> Option<bool> {
        self.show_archived.as_ref().map(|o| *o)
    }
    /// Filters search on data reviews based on the archived statuses provided.
    /// Default is NOT_ARCHIVED only if none are provided.
    #[inline]
    pub fn archived_statuses(
        &self,
    ) -> Option<
        &std::collections::BTreeSet<super::super::super::super::api::ArchivedStatus>,
    > {
        self.archived_statuses.as_ref().map(|o| &*o)
    }
}