nominal-api-conjure 0.1431.0

Conjure HTTP 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

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    conjure_object::private::DeriveWith
)]
#[serde(crate = "conjure_object::serde")]
#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct SearchChannelsRequest {
    #[builder(
        custom(type = super::super::super::compute::api::Dataset, convert = Box::new)
    )]
    #[serde(rename = "scope")]
    scope: Box<super::super::super::compute::api::Dataset>,
    #[builder(custom(type = super::ChannelSearchQuery, convert = Box::new))]
    #[serde(rename = "query")]
    query: Box<super::ChannelSearchQuery>,
    #[builder(
        custom(type = super::super::super::compute::api::Context, convert = Box::new)
    )]
    #[serde(rename = "context")]
    context: Box<super::super::super::compute::api::Context>,
    #[builder(custom(type = super::super::super::super::api::Range, convert = Box::new))]
    #[serde(rename = "timeRange")]
    time_range: Box<super::super::super::super::api::Range>,
    #[builder(default, into)]
    #[serde(
        rename = "maxResultChannels",
        skip_serializing_if = "Option::is_none",
        default
    )]
    max_result_channels: Option<i32>,
    #[builder(
        default,
        set(item(type = super::super::super::super::api::SeriesDataType))
    )]
    #[serde(
        rename = "allowedDataTypes",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    allowed_data_types: std::collections::BTreeSet<
        super::super::super::super::api::SeriesDataType,
    >,
    #[builder(default, into)]
    #[serde(
        rename = "includeProperties",
        skip_serializing_if = "Option::is_none",
        default
    )]
    include_properties: Option<bool>,
}
impl SearchChannelsRequest {
    #[inline]
    pub fn scope(&self) -> &super::super::super::compute::api::Dataset {
        &*self.scope
    }
    #[inline]
    pub fn query(&self) -> &super::ChannelSearchQuery {
        &*self.query
    }
    #[inline]
    pub fn context(&self) -> &super::super::super::compute::api::Context {
        &*self.context
    }
    /// Time filter applied to the search. Only channels with data within this time range will be returned.
    /// A shorter time range will improve performance!
    #[inline]
    pub fn time_range(&self) -> &super::super::super::super::api::Range {
        &*self.time_range
    }
    /// Max number of distinct channels to return. Defaults to 200. Capped at 200.
    #[inline]
    pub fn max_result_channels(&self) -> Option<i32> {
        self.max_result_channels.as_ref().map(|o| *o)
    }
    /// Filter to only channels with these data types, applied before the result cap so a large scope of
    /// other-typed channels cannot crowd the requested types out of the response. An empty set means no
    /// filtering (all data types included). Matching follows API presentation: a DOUBLE filter also matches
    /// channels stored as INT or UINT, which are returned with dataType=DOUBLE.
    #[inline]
    pub fn allowed_data_types(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::super::api::SeriesDataType> {
        &self.allowed_data_types
    }
    /// When true, asset and run properties from resolved branches are included in the ranked results
    /// as Kind.PROPERTY rows. Defaults to false so existing clients keep seeing only channels.
    #[inline]
    pub fn include_properties(&self) -> Option<bool> {
        self.include_properties.as_ref().map(|o| *o)
    }
}