nominal-api 0.1194.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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
// This file is @generated by prost-build.
/// Public-facing write request. Used by external clients via the Conjure HTTP API.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WriteBatchesRequest {
    #[prost(message, repeated, tag = "1")]
    pub batches: ::prost::alloc::vec::Vec<RecordsBatch>,
    #[prost(string, tag = "2")]
    pub data_source_rid: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamingSessionSourceInfo {
    #[prost(oneof = "streaming_session_source_info::Source", tags = "1, 2, 3")]
    pub source: ::core::option::Option<streaming_session_source_info::Source>,
}
/// Nested message and enum types in `StreamingSessionSourceInfo`.
pub mod streaming_session_source_info {
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Source {
        #[prost(message, tag = "1")]
        Mesh(super::MeshStreamingSessionSourceInfo),
        #[prost(message, tag = "2")]
        DataConnector(super::DataConnectorStreamingSessionSourceInfo),
        #[prost(message, tag = "3")]
        Custom(super::CustomStreamingSessionSourceInfo),
    }
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MeshStreamingSessionSourceInfo {
    #[prost(string, tag = "1")]
    pub source_dataset_rid: ::prost::alloc::string::String,
    #[prost(string, tag = "2")]
    pub source_org_rid: ::prost::alloc::string::String,
    #[prost(string, tag = "3")]
    pub origin_streaming_session_source: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataConnectorStreamingSessionSourceInfo {
    #[prost(string, tag = "1")]
    pub data_connector_rid: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CustomStreamingSessionSourceInfo {
    #[prost(string, tag = "1")]
    pub source_name: ::prost::alloc::string::String,
}
/// Internal write request. Used internally by the channel writer, Kafka consumers, and mesh.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InternalWriteBatchesRequest {
    #[prost(message, repeated, tag = "1")]
    pub batches: ::prost::alloc::vec::Vec<RecordsBatch>,
    #[prost(string, tag = "2")]
    pub data_source_rid: ::prost::alloc::string::String,
    #[prost(message, optional, tag = "3")]
    pub source: ::core::option::Option<StreamingSessionSourceInfo>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ArrayPoints {
    #[prost(oneof = "array_points::ArrayType", tags = "1, 2")]
    pub array_type: ::core::option::Option<array_points::ArrayType>,
}
/// Nested message and enum types in `ArrayPoints`.
pub mod array_points {
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum ArrayType {
        #[prost(message, tag = "1")]
        DoubleArrayPoints(super::DoubleArrayPoints),
        #[prost(message, tag = "2")]
        StringArrayPoints(super::StringArrayPoints),
    }
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StringArrayPoints {
    #[prost(message, repeated, tag = "1")]
    pub points: ::prost::alloc::vec::Vec<StringArrayPoint>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StringArrayPoint {
    #[prost(string, repeated, tag = "2")]
    pub value: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DoubleArrayPoints {
    #[prost(message, repeated, tag = "1")]
    pub points: ::prost::alloc::vec::Vec<DoubleArrayPoint>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DoubleArrayPoint {
    #[prost(double, repeated, tag = "2")]
    pub value: ::prost::alloc::vec::Vec<f64>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LogPoints {
    #[prost(message, repeated, tag = "1")]
    pub points: ::prost::alloc::vec::Vec<LogPoint>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LogPoint {
    #[prost(message, optional, tag = "2")]
    pub value: ::core::option::Option<LogValue>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StructPoints {
    #[prost(string, repeated, tag = "1")]
    pub points: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LogValue {
    #[prost(string, tag = "1")]
    pub message: ::prost::alloc::string::String,
    #[prost(map = "string, string", tag = "2")]
    pub args: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        ::prost::alloc::string::String,
    >,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StringPoints {
    #[prost(string, repeated, tag = "1")]
    pub points: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DoublePoints {
    #[prost(double, repeated, tag = "1")]
    pub points: ::prost::alloc::vec::Vec<f64>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IntPoints {
    #[prost(int64, repeated, tag = "1")]
    pub points: ::prost::alloc::vec::Vec<i64>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Uint64Points {
    #[prost(uint64, repeated, tag = "1")]
    pub points: ::prost::alloc::vec::Vec<u64>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Points {
    #[prost(message, repeated, tag = "1")]
    pub timestamps: ::prost::alloc::vec::Vec<super::super::types::time::Timestamp>,
    #[prost(oneof = "points::Points", tags = "2, 3, 4, 5, 6, 7, 8")]
    pub points: ::core::option::Option<points::Points>,
}
/// Nested message and enum types in `Points`.
pub mod points {
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Points {
        #[prost(message, tag = "2")]
        DoublePoints(super::DoublePoints),
        #[prost(message, tag = "3")]
        StringPoints(super::StringPoints),
        #[prost(message, tag = "4")]
        LogPoints(super::LogPoints),
        #[prost(message, tag = "5")]
        IntPoints(super::IntPoints),
        #[prost(message, tag = "6")]
        ArrayPoints(super::ArrayPoints),
        #[prost(message, tag = "7")]
        StructPoints(super::StructPoints),
        #[prost(message, tag = "8")]
        Uint64Points(super::Uint64Points),
    }
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RecordsBatch {
    #[prost(string, tag = "1")]
    pub channel: ::prost::alloc::string::String,
    #[prost(map = "string, string", tag = "2")]
    pub tags: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        ::prost::alloc::string::String,
    >,
    #[prost(message, optional, tag = "3")]
    pub points: ::core::option::Option<Points>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelSeriesMetadata {
    #[prost(string, tag = "1")]
    pub series_id: ::prost::alloc::string::String,
    #[prost(map = "string, string", tag = "2")]
    pub tags: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        ::prost::alloc::string::String,
    >,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelSeriesMetadataBatch {
    #[prost(message, repeated, tag = "1")]
    pub series_metadata: ::prost::alloc::vec::Vec<ChannelSeriesMetadata>,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct WriteBatchesResponse {}
/// buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum NominalDirectChannelWriterError {
    DataSourceNotFound = 0,
    DataSourcesNotFound = 1,
    InvalidNominalDataSource = 2,
    /// The requested data source already exists.
    NominalDataSourceConflict = 3,
    /// Array size exceeds maximum allowed length.
    ArrayTooLarge = 4,
    /// Found two different data types for the same series in the request.
    ConflictingDataTypes = 5,
    /// The nominal data source or dataset provided is invalid.
    InvalidDataSource = 6,
    InvalidTelegrafTimestamp = 7,
    InvalidTimestamp = 8,
    /// Columnar streaming request contains different numbers of timestamps and values
    MismatchedTimestampsAndValues = 9,
    /// Unsupported dataset for streaming.
    StreamingDisabledOnDataset = 10,
    /// The provided Range is invalid because the start time is greater than the end time.
    InvalidRange = 11,
    /// The provided Points type is not set.
    PointsTypeNotSet = 12,
    /// The provided ArrayPoints type is not set.
    ArrayPointsTypeNotSet = 13,
    /// Not authorized to write to the specified data source.
    NotAuthorized = 14,
}
impl NominalDirectChannelWriterError {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            Self::DataSourceNotFound => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_DATA_SOURCE_NOT_FOUND"
            }
            Self::DataSourcesNotFound => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_DATA_SOURCES_NOT_FOUND"
            }
            Self::InvalidNominalDataSource => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_INVALID_NOMINAL_DATA_SOURCE"
            }
            Self::NominalDataSourceConflict => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_NOMINAL_DATA_SOURCE_CONFLICT"
            }
            Self::ArrayTooLarge => "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_ARRAY_TOO_LARGE",
            Self::ConflictingDataTypes => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_CONFLICTING_DATA_TYPES"
            }
            Self::InvalidDataSource => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_INVALID_DATA_SOURCE"
            }
            Self::InvalidTelegrafTimestamp => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_INVALID_TELEGRAF_TIMESTAMP"
            }
            Self::InvalidTimestamp => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_INVALID_TIMESTAMP"
            }
            Self::MismatchedTimestampsAndValues => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_MISMATCHED_TIMESTAMPS_AND_VALUES"
            }
            Self::StreamingDisabledOnDataset => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_STREAMING_DISABLED_ON_DATASET"
            }
            Self::InvalidRange => "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_INVALID_RANGE",
            Self::PointsTypeNotSet => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_POINTS_TYPE_NOT_SET"
            }
            Self::ArrayPointsTypeNotSet => {
                "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_ARRAY_POINTS_TYPE_NOT_SET"
            }
            Self::NotAuthorized => "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_NOT_AUTHORIZED",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_DATA_SOURCE_NOT_FOUND" => {
                Some(Self::DataSourceNotFound)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_DATA_SOURCES_NOT_FOUND" => {
                Some(Self::DataSourcesNotFound)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_INVALID_NOMINAL_DATA_SOURCE" => {
                Some(Self::InvalidNominalDataSource)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_NOMINAL_DATA_SOURCE_CONFLICT" => {
                Some(Self::NominalDataSourceConflict)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_ARRAY_TOO_LARGE" => {
                Some(Self::ArrayTooLarge)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_CONFLICTING_DATA_TYPES" => {
                Some(Self::ConflictingDataTypes)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_INVALID_DATA_SOURCE" => {
                Some(Self::InvalidDataSource)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_INVALID_TELEGRAF_TIMESTAMP" => {
                Some(Self::InvalidTelegrafTimestamp)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_INVALID_TIMESTAMP" => {
                Some(Self::InvalidTimestamp)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_MISMATCHED_TIMESTAMPS_AND_VALUES" => {
                Some(Self::MismatchedTimestampsAndValues)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_STREAMING_DISABLED_ON_DATASET" => {
                Some(Self::StreamingDisabledOnDataset)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_INVALID_RANGE" => {
                Some(Self::InvalidRange)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_POINTS_TYPE_NOT_SET" => {
                Some(Self::PointsTypeNotSet)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_ARRAY_POINTS_TYPE_NOT_SET" => {
                Some(Self::ArrayPointsTypeNotSet)
            }
            "NOMINAL_DIRECT_CHANNEL_WRITER_ERROR_NOT_AUTHORIZED" => {
                Some(Self::NotAuthorized)
            }
            _ => None,
        }
    }
}
/// Generated client implementations.
pub mod direct_nominal_channel_writer_service_client {
    #![allow(
        unused_variables,
        dead_code,
        missing_docs,
        clippy::wildcard_imports,
        clippy::let_unit_value,
    )]
    use tonic::codegen::*;
    use tonic::codegen::http::Uri;
    /// Writes data points directly to Nominal's managed database offering.
    #[derive(Debug, Clone)]
    pub struct DirectNominalChannelWriterServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl DirectNominalChannelWriterServiceClient<tonic::transport::Channel> {
        /// Attempt to create a new client by connecting to a given endpoint.
        pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
        where
            D: TryInto<tonic::transport::Endpoint>,
            D::Error: Into<StdError>,
        {
            let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
            Ok(Self::new(conn))
        }
    }
    impl<T> DirectNominalChannelWriterServiceClient<T>
    where
        T: tonic::client::GrpcService<tonic::body::Body>,
        T::Error: Into<StdError>,
        T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
        <T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
    {
        pub fn new(inner: T) -> Self {
            let inner = tonic::client::Grpc::new(inner);
            Self { inner }
        }
        pub fn with_origin(inner: T, origin: Uri) -> Self {
            let inner = tonic::client::Grpc::with_origin(inner, origin);
            Self { inner }
        }
        pub fn with_interceptor<F>(
            inner: T,
            interceptor: F,
        ) -> DirectNominalChannelWriterServiceClient<InterceptedService<T, F>>
        where
            F: tonic::service::Interceptor,
            T::ResponseBody: Default,
            T: tonic::codegen::Service<
                http::Request<tonic::body::Body>,
                Response = http::Response<
                    <T as tonic::client::GrpcService<tonic::body::Body>>::ResponseBody,
                >,
            >,
            <T as tonic::codegen::Service<
                http::Request<tonic::body::Body>,
            >>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
        {
            DirectNominalChannelWriterServiceClient::new(
                InterceptedService::new(inner, interceptor),
            )
        }
        /// Compress requests with the given encoding.
        ///
        /// This requires the server to support it otherwise it might respond with an
        /// error.
        #[must_use]
        pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.send_compressed(encoding);
            self
        }
        /// Enable decompressing responses.
        #[must_use]
        pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.accept_compressed(encoding);
            self
        }
        /// Limits the maximum size of a decoded message.
        ///
        /// Default: `4MB`
        #[must_use]
        pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_decoding_message_size(limit);
            self
        }
        /// Limits the maximum size of an encoded message.
        ///
        /// Default: `usize::MAX`
        #[must_use]
        pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_encoding_message_size(limit);
            self
        }
        /// buf:lint:ignore RPC_REQUEST_STANDARD_NAME
        /// Synchronously writes batches of records to a Nominal data source. This endpoint bypasses the
        /// Channel Writer service entirely, and should only be used if the implications are well understood.
        ///
        /// If you call this endpoint, writes will go directly into Nominal DB and will not be placed in Nominal's
        /// durable queue. This results in lower latency, but also consequently lower durability.
        pub async fn write_batches(
            &mut self,
            request: impl tonic::IntoRequest<super::InternalWriteBatchesRequest>,
        ) -> std::result::Result<
            tonic::Response<super::WriteBatchesResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.direct_channel_writer.v2.DirectNominalChannelWriterService/WriteBatches",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.direct_channel_writer.v2.DirectNominalChannelWriterService",
                        "WriteBatches",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}