nominal_api/conjure/clients/timeseries/metadata/
series_metadata_service.rs

1use conjure_http::endpoint;
2/// [INTERNAL]
3/// Series metadata represents the constant information about data in a series - specifically, the name, units, a
4/// description, and the tags. Series metadata can be used to query points from specific series depending on the tag
5/// value selections.
6#[conjure_http::conjure_client(name = "SeriesMetadataService")]
7pub trait SeriesMetadataService<
8    #[response_body]
9    I: Iterator<
10            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
11        >,
12> {
13    /// Batch get series metadata by DataSourceRid.
14    #[endpoint(
15        method = POST,
16        path = "/timeseries/archetype/v1/series-archetype/batch-get",
17        name = "batchGet",
18        accept = conjure_http::client::StdResponseDeserializer
19    )]
20    fn batch_get(
21        &self,
22        #[auth]
23        auth_: &conjure_object::BearerToken,
24        #[body(serializer = conjure_http::client::StdRequestSerializer)]
25        request: &super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataRequest,
26    ) -> Result<
27        super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataResponse,
28        conjure_http::private::Error,
29    >;
30    /// Create new series metadata.
31    #[endpoint(
32        method = POST,
33        path = "/timeseries/archetype/v1/series-archetype",
34        name = "create",
35        accept = conjure_http::client::conjure::EmptyResponseDeserializer
36    )]
37    fn create(
38        &self,
39        #[auth]
40        auth_: &conjure_object::BearerToken,
41        #[body(serializer = conjure_http::client::StdRequestSerializer)]
42        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
43    ) -> Result<(), conjure_http::private::Error>;
44    /// Idempotently creates series metadata.
45    #[endpoint(
46        method = POST,
47        path = "/timeseries/archetype/v1/series-archetype/batch-create",
48        name = "batchCreate",
49        accept = conjure_http::client::conjure::EmptyResponseDeserializer
50    )]
51    fn batch_create(
52        &self,
53        #[auth]
54        auth_: &conjure_object::BearerToken,
55        #[body(serializer = conjure_http::client::StdRequestSerializer)]
56        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
57    ) -> Result<(), conjure_http::private::Error>;
58    /// Upserts series metadata. Creates new series metadata if it does not exist for the given channel and data
59    /// source. If it already exists, updates the locator and any provided unit and description fields while
60    /// preserving existing values for fields not supplied.
61    #[endpoint(
62        method = POST,
63        path = "/timeseries/archetype/v1/series-archetype/create-or-update",
64        name = "createOrUpdate",
65        accept = conjure_http::client::conjure::EmptyResponseDeserializer
66    )]
67    fn create_or_update(
68        &self,
69        #[auth]
70        auth_: &conjure_object::BearerToken,
71        #[body(serializer = conjure_http::client::StdRequestSerializer)]
72        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
73    ) -> Result<(), conjure_http::private::Error>;
74    /// Batch version of createOrUpdate.
75    #[endpoint(
76        method = POST,
77        path = "/timeseries/archetype/v1/series-archetype/batch-create-or-update",
78        name = "batchCreateOrUpdate",
79        accept = conjure_http::client::conjure::EmptyResponseDeserializer
80    )]
81    fn batch_create_or_update(
82        &self,
83        #[auth]
84        auth_: &conjure_object::BearerToken,
85        #[body(serializer = conjure_http::client::StdRequestSerializer)]
86        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
87    ) -> Result<(), conjure_http::private::Error>;
88    /// Get series metadata from its series metadata rid.
89    #[endpoint(
90        method = GET,
91        path = "/timeseries/archetype/v1/series-archetype/{rid}",
92        name = "get",
93        accept = conjure_http::client::StdResponseDeserializer
94    )]
95    fn get(
96        &self,
97        #[auth]
98        auth_: &conjure_object::BearerToken,
99        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
100        rid: &conjure_object::ResourceIdentifier,
101    ) -> Result<
102        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
103        conjure_http::private::Error,
104    >;
105    /// Update existing series metadata.
106    /// Throws SeriesMetadataNotFound if the series metadata does not exist.
107    #[endpoint(
108        method = POST,
109        path = "/timeseries/archetype/v1/series-archetype/{rid}/metadata",
110        name = "updateMetadata",
111        accept = conjure_http::client::StdResponseDeserializer
112    )]
113    fn update_metadata(
114        &self,
115        #[auth]
116        auth_: &conjure_object::BearerToken,
117        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
118        rid: &conjure_object::ResourceIdentifier,
119        #[body(serializer = conjure_http::client::StdRequestSerializer)]
120        request: &super::super::super::super::objects::timeseries::metadata::api::UpdateSeriesMetadataRequest,
121    ) -> Result<
122        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
123        conjure_http::private::Error,
124    >;
125    /// This endpoint lets an authorized workspace caller change how one nominal dataset channel is interpreted.
126    /// This updates metadata and future series resolution. It does not rewrite historical point rows.
127    #[endpoint(
128        method = POST,
129        path = "/timeseries/archetype/v1/series-archetype/change-data-type",
130        name = "changeDataType",
131        accept = conjure_http::client::StdResponseDeserializer
132    )]
133    fn change_data_type(
134        &self,
135        #[auth]
136        auth_: &conjure_object::BearerToken,
137        #[body(serializer = conjure_http::client::StdRequestSerializer)]
138        request: &super::super::super::super::objects::timeseries::metadata::api::ChangeDataTypeRequest,
139    ) -> Result<
140        super::super::super::super::objects::timeseries::metadata::api::ChangeDataTypeResponse,
141        conjure_http::private::Error,
142    >;
143    /// Batch creates series metadata for video channels if they don't exist.
144    /// Idempotent - returns existing SeriesMetadataRid if already exists.
145    #[endpoint(
146        method = POST,
147        path = "/timeseries/archetype/v1/series-archetype/video-channel",
148        name = "batchCreateVideoSeries",
149        accept = conjure_http::client::StdResponseDeserializer
150    )]
151    fn batch_create_video_series(
152        &self,
153        #[auth]
154        auth_: &conjure_object::BearerToken,
155        #[body(serializer = conjure_http::client::StdRequestSerializer)]
156        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesRequest,
157    ) -> Result<
158        super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesResponse,
159        conjure_http::private::Error,
160    >;
161}
162/// [INTERNAL]
163/// Series metadata represents the constant information about data in a series - specifically, the name, units, a
164/// description, and the tags. Series metadata can be used to query points from specific series depending on the tag
165/// value selections.
166#[conjure_http::conjure_client(name = "SeriesMetadataService")]
167pub trait AsyncSeriesMetadataService<
168    #[response_body]
169    I: conjure_http::private::Stream<
170            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
171        >,
172> {
173    /// Batch get series metadata by DataSourceRid.
174    #[endpoint(
175        method = POST,
176        path = "/timeseries/archetype/v1/series-archetype/batch-get",
177        name = "batchGet",
178        accept = conjure_http::client::StdResponseDeserializer
179    )]
180    async fn batch_get(
181        &self,
182        #[auth]
183        auth_: &conjure_object::BearerToken,
184        #[body(serializer = conjure_http::client::StdRequestSerializer)]
185        request: &super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataRequest,
186    ) -> Result<
187        super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataResponse,
188        conjure_http::private::Error,
189    >;
190    /// Create new series metadata.
191    #[endpoint(
192        method = POST,
193        path = "/timeseries/archetype/v1/series-archetype",
194        name = "create",
195        accept = conjure_http::client::conjure::EmptyResponseDeserializer
196    )]
197    async fn create(
198        &self,
199        #[auth]
200        auth_: &conjure_object::BearerToken,
201        #[body(serializer = conjure_http::client::StdRequestSerializer)]
202        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
203    ) -> Result<(), conjure_http::private::Error>;
204    /// Idempotently creates series metadata.
205    #[endpoint(
206        method = POST,
207        path = "/timeseries/archetype/v1/series-archetype/batch-create",
208        name = "batchCreate",
209        accept = conjure_http::client::conjure::EmptyResponseDeserializer
210    )]
211    async fn batch_create(
212        &self,
213        #[auth]
214        auth_: &conjure_object::BearerToken,
215        #[body(serializer = conjure_http::client::StdRequestSerializer)]
216        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
217    ) -> Result<(), conjure_http::private::Error>;
218    /// Upserts series metadata. Creates new series metadata if it does not exist for the given channel and data
219    /// source. If it already exists, updates the locator and any provided unit and description fields while
220    /// preserving existing values for fields not supplied.
221    #[endpoint(
222        method = POST,
223        path = "/timeseries/archetype/v1/series-archetype/create-or-update",
224        name = "createOrUpdate",
225        accept = conjure_http::client::conjure::EmptyResponseDeserializer
226    )]
227    async fn create_or_update(
228        &self,
229        #[auth]
230        auth_: &conjure_object::BearerToken,
231        #[body(serializer = conjure_http::client::StdRequestSerializer)]
232        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
233    ) -> Result<(), conjure_http::private::Error>;
234    /// Batch version of createOrUpdate.
235    #[endpoint(
236        method = POST,
237        path = "/timeseries/archetype/v1/series-archetype/batch-create-or-update",
238        name = "batchCreateOrUpdate",
239        accept = conjure_http::client::conjure::EmptyResponseDeserializer
240    )]
241    async fn batch_create_or_update(
242        &self,
243        #[auth]
244        auth_: &conjure_object::BearerToken,
245        #[body(serializer = conjure_http::client::StdRequestSerializer)]
246        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
247    ) -> Result<(), conjure_http::private::Error>;
248    /// Get series metadata from its series metadata rid.
249    #[endpoint(
250        method = GET,
251        path = "/timeseries/archetype/v1/series-archetype/{rid}",
252        name = "get",
253        accept = conjure_http::client::StdResponseDeserializer
254    )]
255    async fn get(
256        &self,
257        #[auth]
258        auth_: &conjure_object::BearerToken,
259        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
260        rid: &conjure_object::ResourceIdentifier,
261    ) -> Result<
262        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
263        conjure_http::private::Error,
264    >;
265    /// Update existing series metadata.
266    /// Throws SeriesMetadataNotFound if the series metadata does not exist.
267    #[endpoint(
268        method = POST,
269        path = "/timeseries/archetype/v1/series-archetype/{rid}/metadata",
270        name = "updateMetadata",
271        accept = conjure_http::client::StdResponseDeserializer
272    )]
273    async fn update_metadata(
274        &self,
275        #[auth]
276        auth_: &conjure_object::BearerToken,
277        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
278        rid: &conjure_object::ResourceIdentifier,
279        #[body(serializer = conjure_http::client::StdRequestSerializer)]
280        request: &super::super::super::super::objects::timeseries::metadata::api::UpdateSeriesMetadataRequest,
281    ) -> Result<
282        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
283        conjure_http::private::Error,
284    >;
285    /// This endpoint lets an authorized workspace caller change how one nominal dataset channel is interpreted.
286    /// This updates metadata and future series resolution. It does not rewrite historical point rows.
287    #[endpoint(
288        method = POST,
289        path = "/timeseries/archetype/v1/series-archetype/change-data-type",
290        name = "changeDataType",
291        accept = conjure_http::client::StdResponseDeserializer
292    )]
293    async fn change_data_type(
294        &self,
295        #[auth]
296        auth_: &conjure_object::BearerToken,
297        #[body(serializer = conjure_http::client::StdRequestSerializer)]
298        request: &super::super::super::super::objects::timeseries::metadata::api::ChangeDataTypeRequest,
299    ) -> Result<
300        super::super::super::super::objects::timeseries::metadata::api::ChangeDataTypeResponse,
301        conjure_http::private::Error,
302    >;
303    /// Batch creates series metadata for video channels if they don't exist.
304    /// Idempotent - returns existing SeriesMetadataRid if already exists.
305    #[endpoint(
306        method = POST,
307        path = "/timeseries/archetype/v1/series-archetype/video-channel",
308        name = "batchCreateVideoSeries",
309        accept = conjure_http::client::StdResponseDeserializer
310    )]
311    async fn batch_create_video_series(
312        &self,
313        #[auth]
314        auth_: &conjure_object::BearerToken,
315        #[body(serializer = conjure_http::client::StdRequestSerializer)]
316        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesRequest,
317    ) -> Result<
318        super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesResponse,
319        conjure_http::private::Error,
320    >;
321}
322/// [INTERNAL]
323/// Series metadata represents the constant information about data in a series - specifically, the name, units, a
324/// description, and the tags. Series metadata can be used to query points from specific series depending on the tag
325/// value selections.
326#[conjure_http::conjure_client(name = "SeriesMetadataService", local)]
327pub trait LocalAsyncSeriesMetadataService<
328    #[response_body]
329    I: conjure_http::private::Stream<
330            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
331        >,
332> {
333    /// Batch get series metadata by DataSourceRid.
334    #[endpoint(
335        method = POST,
336        path = "/timeseries/archetype/v1/series-archetype/batch-get",
337        name = "batchGet",
338        accept = conjure_http::client::StdResponseDeserializer
339    )]
340    async fn batch_get(
341        &self,
342        #[auth]
343        auth_: &conjure_object::BearerToken,
344        #[body(serializer = conjure_http::client::StdRequestSerializer)]
345        request: &super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataRequest,
346    ) -> Result<
347        super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataResponse,
348        conjure_http::private::Error,
349    >;
350    /// Create new series metadata.
351    #[endpoint(
352        method = POST,
353        path = "/timeseries/archetype/v1/series-archetype",
354        name = "create",
355        accept = conjure_http::client::conjure::EmptyResponseDeserializer
356    )]
357    async fn create(
358        &self,
359        #[auth]
360        auth_: &conjure_object::BearerToken,
361        #[body(serializer = conjure_http::client::StdRequestSerializer)]
362        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
363    ) -> Result<(), conjure_http::private::Error>;
364    /// Idempotently creates series metadata.
365    #[endpoint(
366        method = POST,
367        path = "/timeseries/archetype/v1/series-archetype/batch-create",
368        name = "batchCreate",
369        accept = conjure_http::client::conjure::EmptyResponseDeserializer
370    )]
371    async fn batch_create(
372        &self,
373        #[auth]
374        auth_: &conjure_object::BearerToken,
375        #[body(serializer = conjure_http::client::StdRequestSerializer)]
376        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
377    ) -> Result<(), conjure_http::private::Error>;
378    /// Upserts series metadata. Creates new series metadata if it does not exist for the given channel and data
379    /// source. If it already exists, updates the locator and any provided unit and description fields while
380    /// preserving existing values for fields not supplied.
381    #[endpoint(
382        method = POST,
383        path = "/timeseries/archetype/v1/series-archetype/create-or-update",
384        name = "createOrUpdate",
385        accept = conjure_http::client::conjure::EmptyResponseDeserializer
386    )]
387    async fn create_or_update(
388        &self,
389        #[auth]
390        auth_: &conjure_object::BearerToken,
391        #[body(serializer = conjure_http::client::StdRequestSerializer)]
392        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
393    ) -> Result<(), conjure_http::private::Error>;
394    /// Batch version of createOrUpdate.
395    #[endpoint(
396        method = POST,
397        path = "/timeseries/archetype/v1/series-archetype/batch-create-or-update",
398        name = "batchCreateOrUpdate",
399        accept = conjure_http::client::conjure::EmptyResponseDeserializer
400    )]
401    async fn batch_create_or_update(
402        &self,
403        #[auth]
404        auth_: &conjure_object::BearerToken,
405        #[body(serializer = conjure_http::client::StdRequestSerializer)]
406        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
407    ) -> Result<(), conjure_http::private::Error>;
408    /// Get series metadata from its series metadata rid.
409    #[endpoint(
410        method = GET,
411        path = "/timeseries/archetype/v1/series-archetype/{rid}",
412        name = "get",
413        accept = conjure_http::client::StdResponseDeserializer
414    )]
415    async fn get(
416        &self,
417        #[auth]
418        auth_: &conjure_object::BearerToken,
419        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
420        rid: &conjure_object::ResourceIdentifier,
421    ) -> Result<
422        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
423        conjure_http::private::Error,
424    >;
425    /// Update existing series metadata.
426    /// Throws SeriesMetadataNotFound if the series metadata does not exist.
427    #[endpoint(
428        method = POST,
429        path = "/timeseries/archetype/v1/series-archetype/{rid}/metadata",
430        name = "updateMetadata",
431        accept = conjure_http::client::StdResponseDeserializer
432    )]
433    async fn update_metadata(
434        &self,
435        #[auth]
436        auth_: &conjure_object::BearerToken,
437        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
438        rid: &conjure_object::ResourceIdentifier,
439        #[body(serializer = conjure_http::client::StdRequestSerializer)]
440        request: &super::super::super::super::objects::timeseries::metadata::api::UpdateSeriesMetadataRequest,
441    ) -> Result<
442        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
443        conjure_http::private::Error,
444    >;
445    /// This endpoint lets an authorized workspace caller change how one nominal dataset channel is interpreted.
446    /// This updates metadata and future series resolution. It does not rewrite historical point rows.
447    #[endpoint(
448        method = POST,
449        path = "/timeseries/archetype/v1/series-archetype/change-data-type",
450        name = "changeDataType",
451        accept = conjure_http::client::StdResponseDeserializer
452    )]
453    async fn change_data_type(
454        &self,
455        #[auth]
456        auth_: &conjure_object::BearerToken,
457        #[body(serializer = conjure_http::client::StdRequestSerializer)]
458        request: &super::super::super::super::objects::timeseries::metadata::api::ChangeDataTypeRequest,
459    ) -> Result<
460        super::super::super::super::objects::timeseries::metadata::api::ChangeDataTypeResponse,
461        conjure_http::private::Error,
462    >;
463    /// Batch creates series metadata for video channels if they don't exist.
464    /// Idempotent - returns existing SeriesMetadataRid if already exists.
465    #[endpoint(
466        method = POST,
467        path = "/timeseries/archetype/v1/series-archetype/video-channel",
468        name = "batchCreateVideoSeries",
469        accept = conjure_http::client::StdResponseDeserializer
470    )]
471    async fn batch_create_video_series(
472        &self,
473        #[auth]
474        auth_: &conjure_object::BearerToken,
475        #[body(serializer = conjure_http::client::StdRequestSerializer)]
476        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesRequest,
477    ) -> Result<
478        super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesResponse,
479        conjure_http::private::Error,
480    >;
481}
nominal_api/conjure/clients/timeseries/metadata/series_metadata_service.rs

nominal_api/conjure/clients/timeseries/metadata/
series_metadata_service.rs
