nominal_api_conjure/conjure/objects/scout/channel/api/
locator.rs

1/// One expanded leaf of the dataset. Semantic fields (assetRid, runRid, dataScope)
2/// carry the branch context from dataset expansion.
3#[derive(
4    Debug,
5    Clone,
6    conjure_object::serde::Serialize,
7    conjure_object::serde::Deserialize,
8    PartialEq,
9    Eq,
10    PartialOrd,
11    Ord,
12    Hash
13)]
14#[serde(crate = "conjure_object::serde")]
15#[conjure_object::private::staged_builder::staged_builder]
16#[builder(crate = conjure_object::private::staged_builder, update, inline)]
17pub struct Locator {
18    #[builder(default, into)]
19    #[serde(rename = "assetRid", skip_serializing_if = "Option::is_none", default)]
20    asset_rid: Option<super::super::super::rids::api::AssetRid>,
21    #[builder(default, into)]
22    #[serde(rename = "runRid", skip_serializing_if = "Option::is_none", default)]
23    run_rid: Option<super::super::super::run::api::RunRid>,
24    #[builder(default, into)]
25    #[serde(rename = "dataScope", skip_serializing_if = "Option::is_none", default)]
26    data_scope: Option<String>,
27    #[serde(rename = "dataSourceRid")]
28    data_source_rid: super::super::super::super::api::rids::DataSourceRid,
29    #[builder(
30        default,
31        custom(
32            type = impl
33            Into<Option<super::super::super::super::api::Range>>,
34            convert = |v|v.into().map(Box::new)
35        )
36    )]
37    #[serde(rename = "timeRange", skip_serializing_if = "Option::is_none", default)]
38    time_range: Option<Box<super::super::super::super::api::Range>>,
39    #[builder(
40        default,
41        map(
42            key(type = super::super::super::super::api::TagName),
43            value(type = super::super::super::super::api::TagValue)
44        )
45    )]
46    #[serde(
47        rename = "injectedTags",
48        skip_serializing_if = "std::collections::BTreeMap::is_empty",
49        default
50    )]
51    injected_tags: std::collections::BTreeMap<
52        super::super::super::super::api::TagName,
53        super::super::super::super::api::TagValue,
54    >,
55}
56impl Locator {
57    /// Constructs a new instance of the type.
58    #[inline]
59    pub fn new(
60        data_source_rid: super::super::super::super::api::rids::DataSourceRid,
61    ) -> Self {
62        Self::builder().data_source_rid(data_source_rid).build()
63    }
64    #[inline]
65    pub fn asset_rid(&self) -> Option<&super::super::super::rids::api::AssetRid> {
66        self.asset_rid.as_ref().map(|o| &*o)
67    }
68    #[inline]
69    pub fn run_rid(&self) -> Option<&super::super::super::run::api::RunRid> {
70        self.run_rid.as_ref().map(|o| &*o)
71    }
72    #[inline]
73    pub fn data_scope(&self) -> Option<&str> {
74        self.data_scope.as_ref().map(|o| &**o)
75    }
76    #[inline]
77    pub fn data_source_rid(
78        &self,
79    ) -> &super::super::super::super::api::rids::DataSourceRid {
80        &self.data_source_rid
81    }
82    /// Effective source time range used for this expanded locator. This can differ from the request time range
83    /// when the dataset includes transforms such as `Dataset.timeShift`.
84    #[inline]
85    pub fn time_range(&self) -> Option<&super::super::super::super::api::Range> {
86        self.time_range.as_ref().map(|o| &**o)
87    }
88    /// Dataset-injected tags accumulated along this branch's resolution path. This includes reserved branch tags
89    /// such as ASSET_RID, RUN_RID, and DATA_SCOPE, data-scope series tags, and explicit TaggedDataset pairs.
90    #[inline]
91    pub fn injected_tags(
92        &self,
93    ) -> &std::collections::BTreeMap<
94        super::super::super::super::api::TagName,
95        super::super::super::super::api::TagValue,
96    > {
97        &self.injected_tags
98    }
99}
nominal_api_conjure/conjure/objects/scout/channel/api/locator.rs

nominal_api_conjure/conjure/objects/scout/channel/api/
locator.rs
