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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

/// Options for ingesting parquet files.
/// Supported file formats include .parquet, .parquet.gz
/// and archives such as .tar, .tar.gz, and .zip (must set the isArchive flag).
#[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 ParquetOpts {
    #[builder(custom(type = super::IngestSource, convert = Box::new))]
    #[serde(rename = "source")]
    source: Box<super::IngestSource>,
    #[builder(custom(type = super::DatasetIngestTarget, convert = Box::new))]
    #[serde(rename = "target")]
    target: Box<super::DatasetIngestTarget>,
    #[builder(custom(type = super::TimestampMetadata, convert = Box::new))]
    #[serde(rename = "timestampMetadata")]
    timestamp_metadata: Box<super::TimestampMetadata>,
    #[builder(default)]
    #[serde(rename = "channelPrefix", skip_serializing_if = "Option::is_none", default)]
    channel_prefix: super::ChannelPrefix,
    #[builder(default, into)]
    #[serde(
        rename = "tagKeysFromColumns",
        skip_serializing_if = "Option::is_none",
        default
    )]
    tag_keys_from_columns: Option<
        std::collections::BTreeSet<super::super::super::api::TagName>,
    >,
    #[builder(default, into)]
    #[serde(rename = "tagColumns", skip_serializing_if = "Option::is_none", default)]
    tag_columns: Option<
        std::collections::BTreeMap<
            super::super::super::api::TagName,
            super::super::super::api::ColumnName,
        >,
    >,
    #[builder(default, into)]
    #[serde(
        rename = "additionalFileTags",
        skip_serializing_if = "Option::is_none",
        default
    )]
    additional_file_tags: Option<
        std::collections::BTreeMap<
            super::super::super::api::TagName,
            super::super::super::api::TagValue,
        >,
    >,
    #[builder(default, into)]
    #[serde(rename = "isArchive", skip_serializing_if = "Option::is_none", default)]
    is_archive: Option<bool>,
    #[builder(default, set(item(type = super::super::super::api::ColumnName)))]
    #[serde(
        rename = "excludeColumns",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    exclude_columns: std::collections::BTreeSet<super::super::super::api::ColumnName>,
}
impl ParquetOpts {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        source: super::IngestSource,
        target: super::DatasetIngestTarget,
        timestamp_metadata: super::TimestampMetadata,
    ) -> Self {
        Self::builder()
            .source(source)
            .target(target)
            .timestamp_metadata(timestamp_metadata)
            .build()
    }
    #[inline]
    pub fn source(&self) -> &super::IngestSource {
        &*self.source
    }
    #[inline]
    pub fn target(&self) -> &super::DatasetIngestTarget {
        &*self.target
    }
    #[inline]
    pub fn timestamp_metadata(&self) -> &super::TimestampMetadata {
        &*self.timestamp_metadata
    }
    #[inline]
    pub fn channel_prefix(&self) -> &super::ChannelPrefix {
        &self.channel_prefix
    }
    #[deprecated(note = "Deprecated in favor of tagColumns.")]
    #[inline]
    pub fn tag_keys_from_columns(
        &self,
    ) -> Option<&std::collections::BTreeSet<super::super::super::api::TagName>> {
        self.tag_keys_from_columns.as_ref().map(|o| &*o)
    }
    /// A map of tag names to column names to derive the tag values from.
    #[inline]
    pub fn tag_columns(
        &self,
    ) -> Option<
        &std::collections::BTreeMap<
            super::super::super::api::TagName,
            super::super::super::api::ColumnName,
        >,
    > {
        self.tag_columns.as_ref().map(|o| &*o)
    }
    /// Specifies a tag set to apply to all data in the file.
    #[inline]
    pub fn additional_file_tags(
        &self,
    ) -> Option<
        &std::collections::BTreeMap<
            super::super::super::api::TagName,
            super::super::super::api::TagValue,
        >,
    > {
        self.additional_file_tags.as_ref().map(|o| &*o)
    }
    /// If true, the file is an archive. Supported archive formats include
    /// .tar, .tar.gz, and .zip. Only files ending in .parquet
    /// within the archive will be ingested. If field not provided, defaults to false.
    #[inline]
    pub fn is_archive(&self) -> Option<bool> {
        self.is_archive.as_ref().map(|o| *o)
    }
    /// A set of column names to exclude from ingestion. These columns will not be
    /// ingested as channels. Useful for excluding columns that contain unsupported
    /// data types like multidimensional arrays.
    #[inline]
    pub fn exclude_columns(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::api::ColumnName> {
        &self.exclude_columns
    }
}