nominal-api-conjure 0.1452.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
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
127
128
129

#[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 UpdateDatasetMetadata {
    #[builder(default, into)]
    #[serde(rename = "name", skip_serializing_if = "Option::is_none", default)]
    name: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
    description: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "labels", skip_serializing_if = "Option::is_none", default)]
    labels: Option<std::collections::BTreeSet<super::super::super::api::Label>>,
    #[builder(default, into)]
    #[serde(rename = "properties", skip_serializing_if = "Option::is_none", default)]
    properties: Option<
        std::collections::BTreeMap<
            super::super::super::api::PropertyName,
            super::super::super::api::PropertyValue,
        >,
    >,
    #[builder(default, into)]
    #[serde(
        rename = "typedProperties",
        skip_serializing_if = "Option::is_none",
        default
    )]
    typed_properties: Option<
        std::collections::BTreeMap<
            super::super::super::api::PropertyName,
            super::super::super::api::TypedPropertyValue,
        >,
    >,
    #[builder(default, into)]
    #[serde(
        rename = "channelSearchSplitTagKeys",
        skip_serializing_if = "Option::is_none",
        default
    )]
    channel_search_split_tag_keys: Option<
        std::collections::BTreeSet<super::super::super::api::TagName>,
    >,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::DefaultGroupByAndAggregationConfig>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(
        rename = "defaultGroupByAndAggregationConfig",
        skip_serializing_if = "Option::is_none",
        default
    )]
    default_group_by_and_aggregation_config: Option<
        Box<super::DefaultGroupByAndAggregationConfig>,
    >,
}
impl UpdateDatasetMetadata {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new() -> Self {
        Self::builder().build()
    }
    #[inline]
    pub fn name(&self) -> Option<&str> {
        self.name.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn labels(
        &self,
    ) -> Option<&std::collections::BTreeSet<super::super::super::api::Label>> {
        self.labels.as_ref().map(|o| &*o)
    }
    /// User-defined dataset properties. When supplied, the UTF-8 JSON serialization must not exceed 2,000
    /// bytes.
    #[deprecated(note = "use typedProperties")]
    #[inline]
    pub fn properties(
        &self,
    ) -> Option<
        &std::collections::BTreeMap<
            super::super::super::api::PropertyName,
            super::super::super::api::PropertyValue,
        >,
    > {
        self.properties.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn typed_properties(
        &self,
    ) -> Option<
        &std::collections::BTreeMap<
            super::super::super::api::PropertyName,
            super::super::super::api::TypedPropertyValue,
        >,
    > {
        self.typed_properties.as_ref().map(|o| &*o)
    }
    /// Tag keys whose distinct values channel search surfaces as separate series. Absent leaves the current
    /// keys unchanged; an empty set clears them. Every key must be produced by the dataset's
    /// `derivedDefinition`.
    #[inline]
    pub fn channel_search_split_tag_keys(
        &self,
    ) -> Option<&std::collections::BTreeSet<super::super::super::api::TagName>> {
        self.channel_search_split_tag_keys.as_ref().map(|o| &*o)
    }
    /// If set, replaces the dataset's default group-by and aggregation config in full.
    #[inline]
    pub fn default_group_by_and_aggregation_config(
        &self,
    ) -> Option<&super::DefaultGroupByAndAggregationConfig> {
        self.default_group_by_and_aggregation_config.as_ref().map(|o| &**o)
    }
}