nominal-api-conjure 0.1443.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

#[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 StandardValve {
    #[serde(rename = "feedbackChannelVariableName")]
    feedback_channel_variable_name: super::super::super::channelvariables::api::ChannelVariableName,
    #[builder(default, list(item(type = super::ValveStateMapping)))]
    #[serde(rename = "stateMappings", skip_serializing_if = "Vec::is_empty", default)]
    state_mappings: Vec<super::ValveStateMapping>,
    #[builder(default, list(item(type = super::VizActionOption)))]
    #[serde(rename = "actions", skip_serializing_if = "Vec::is_empty", default)]
    actions: Vec<super::VizActionOption>,
}
impl StandardValve {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        feedback_channel_variable_name: super::super::super::channelvariables::api::ChannelVariableName,
    ) -> Self {
        Self::builder()
            .feedback_channel_variable_name(feedback_channel_variable_name)
            .build()
    }
    /// Workbook channel variable providing valve feedback.
    #[inline]
    pub fn feedback_channel_variable_name(
        &self,
    ) -> &super::super::super::channelvariables::api::ChannelVariableName {
        &self.feedback_channel_variable_name
    }
    /// One or two rules with distinct states; first match wins.
    /// Missing, non-finite, or unmatched feedback renders unknown.
    #[inline]
    pub fn state_mappings(&self) -> &[super::ValveStateMapping] {
        &*self.state_mappings
    }
    /// Up to 32 choices in menu order. Clicking opens the menu; explicit
    /// selection executes only that choice's batch. All choices remain
    /// available regardless of feedback state. Empty means feedback-only.
    #[inline]
    pub fn actions(&self) -> &[super::VizActionOption] {
        &*self.actions
    }
}