nominal_api/conjure/clients/timeseries/channelmetadata/
channel_metadata_service.rs

1use conjure_http::endpoint;
2/// Endpoints for retrieving and updating channel metadata.
3#[conjure_http::conjure_client(name = "ChannelMetadataService")]
4pub trait ChannelMetadataService<
5    #[response_body]
6    I: Iterator<
7            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
8        >,
9> {
10    /// Get the metadata for a channel.
11    #[endpoint(
12        method = POST,
13        path = "/timeseries/channel-metadata/v1/channel-metadata/get",
14        name = "getChannelMetadata",
15        accept = conjure_http::client::StdResponseDeserializer
16    )]
17    fn get_channel_metadata(
18        &self,
19        #[auth]
20        auth_: &conjure_object::BearerToken,
21        #[body(serializer = conjure_http::client::StdRequestSerializer)]
22        request: &super::super::super::super::objects::timeseries::channelmetadata::api::GetChannelMetadataRequest,
23    ) -> Result<
24        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
25        conjure_http::private::Error,
26    >;
27    /// Batch get the metadata for multiple channels. If some channels cannot be found or authorized,
28    /// they will be omitted from the response.
29    #[endpoint(
30        method = POST,
31        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-get",
32        name = "batchGetChannelMetadata",
33        accept = conjure_http::client::StdResponseDeserializer
34    )]
35    fn batch_get_channel_metadata(
36        &self,
37        #[auth]
38        auth_: &conjure_object::BearerToken,
39        #[body(serializer = conjure_http::client::StdRequestSerializer)]
40        request: &super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataRequest,
41    ) -> Result<
42        super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataResponse,
43        conjure_http::private::Error,
44    >;
45    /// Update the metadata for a channel.
46    #[endpoint(
47        method = POST,
48        path = "/timeseries/channel-metadata/v1/channel-metadata/update",
49        name = "updateChannelMetadata",
50        accept = conjure_http::client::StdResponseDeserializer
51    )]
52    fn update_channel_metadata(
53        &self,
54        #[auth]
55        auth_: &conjure_object::BearerToken,
56        #[body(serializer = conjure_http::client::StdRequestSerializer)]
57        request: &super::super::super::super::objects::timeseries::channelmetadata::api::UpdateChannelMetadataRequest,
58    ) -> Result<
59        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
60        conjure_http::private::Error,
61    >;
62    /// Batch update the metadata for multiple channels. If some channels cannot be found or authorized,
63    /// no metadata will be updated for any of the channels in the request.
64    #[endpoint(
65        method = POST,
66        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-update",
67        name = "batchUpdateChannelMetadata",
68        accept = conjure_http::client::StdResponseDeserializer
69    )]
70    fn batch_update_channel_metadata(
71        &self,
72        #[auth]
73        auth_: &conjure_object::BearerToken,
74        #[body(serializer = conjure_http::client::StdRequestSerializer)]
75        request: &super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataRequest,
76    ) -> Result<
77        super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataResponse,
78        conjure_http::private::Error,
79    >;
80}
81/// Endpoints for retrieving and updating channel metadata.
82#[conjure_http::conjure_client(name = "ChannelMetadataService")]
83pub trait AsyncChannelMetadataService<
84    #[response_body]
85    I: conjure_http::private::Stream<
86            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
87        >,
88> {
89    /// Get the metadata for a channel.
90    #[endpoint(
91        method = POST,
92        path = "/timeseries/channel-metadata/v1/channel-metadata/get",
93        name = "getChannelMetadata",
94        accept = conjure_http::client::StdResponseDeserializer
95    )]
96    async fn get_channel_metadata(
97        &self,
98        #[auth]
99        auth_: &conjure_object::BearerToken,
100        #[body(serializer = conjure_http::client::StdRequestSerializer)]
101        request: &super::super::super::super::objects::timeseries::channelmetadata::api::GetChannelMetadataRequest,
102    ) -> Result<
103        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
104        conjure_http::private::Error,
105    >;
106    /// Batch get the metadata for multiple channels. If some channels cannot be found or authorized,
107    /// they will be omitted from the response.
108    #[endpoint(
109        method = POST,
110        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-get",
111        name = "batchGetChannelMetadata",
112        accept = conjure_http::client::StdResponseDeserializer
113    )]
114    async fn batch_get_channel_metadata(
115        &self,
116        #[auth]
117        auth_: &conjure_object::BearerToken,
118        #[body(serializer = conjure_http::client::StdRequestSerializer)]
119        request: &super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataRequest,
120    ) -> Result<
121        super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataResponse,
122        conjure_http::private::Error,
123    >;
124    /// Update the metadata for a channel.
125    #[endpoint(
126        method = POST,
127        path = "/timeseries/channel-metadata/v1/channel-metadata/update",
128        name = "updateChannelMetadata",
129        accept = conjure_http::client::StdResponseDeserializer
130    )]
131    async fn update_channel_metadata(
132        &self,
133        #[auth]
134        auth_: &conjure_object::BearerToken,
135        #[body(serializer = conjure_http::client::StdRequestSerializer)]
136        request: &super::super::super::super::objects::timeseries::channelmetadata::api::UpdateChannelMetadataRequest,
137    ) -> Result<
138        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
139        conjure_http::private::Error,
140    >;
141    /// Batch update the metadata for multiple channels. If some channels cannot be found or authorized,
142    /// no metadata will be updated for any of the channels in the request.
143    #[endpoint(
144        method = POST,
145        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-update",
146        name = "batchUpdateChannelMetadata",
147        accept = conjure_http::client::StdResponseDeserializer
148    )]
149    async fn batch_update_channel_metadata(
150        &self,
151        #[auth]
152        auth_: &conjure_object::BearerToken,
153        #[body(serializer = conjure_http::client::StdRequestSerializer)]
154        request: &super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataRequest,
155    ) -> Result<
156        super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataResponse,
157        conjure_http::private::Error,
158    >;
159}
160/// Endpoints for retrieving and updating channel metadata.
161#[conjure_http::conjure_client(name = "ChannelMetadataService", local)]
162pub trait LocalAsyncChannelMetadataService<
163    #[response_body]
164    I: conjure_http::private::Stream<
165            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
166        >,
167> {
168    /// Get the metadata for a channel.
169    #[endpoint(
170        method = POST,
171        path = "/timeseries/channel-metadata/v1/channel-metadata/get",
172        name = "getChannelMetadata",
173        accept = conjure_http::client::StdResponseDeserializer
174    )]
175    async fn get_channel_metadata(
176        &self,
177        #[auth]
178        auth_: &conjure_object::BearerToken,
179        #[body(serializer = conjure_http::client::StdRequestSerializer)]
180        request: &super::super::super::super::objects::timeseries::channelmetadata::api::GetChannelMetadataRequest,
181    ) -> Result<
182        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
183        conjure_http::private::Error,
184    >;
185    /// Batch get the metadata for multiple channels. If some channels cannot be found or authorized,
186    /// they will be omitted from the response.
187    #[endpoint(
188        method = POST,
189        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-get",
190        name = "batchGetChannelMetadata",
191        accept = conjure_http::client::StdResponseDeserializer
192    )]
193    async fn batch_get_channel_metadata(
194        &self,
195        #[auth]
196        auth_: &conjure_object::BearerToken,
197        #[body(serializer = conjure_http::client::StdRequestSerializer)]
198        request: &super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataRequest,
199    ) -> Result<
200        super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataResponse,
201        conjure_http::private::Error,
202    >;
203    /// Update the metadata for a channel.
204    #[endpoint(
205        method = POST,
206        path = "/timeseries/channel-metadata/v1/channel-metadata/update",
207        name = "updateChannelMetadata",
208        accept = conjure_http::client::StdResponseDeserializer
209    )]
210    async fn update_channel_metadata(
211        &self,
212        #[auth]
213        auth_: &conjure_object::BearerToken,
214        #[body(serializer = conjure_http::client::StdRequestSerializer)]
215        request: &super::super::super::super::objects::timeseries::channelmetadata::api::UpdateChannelMetadataRequest,
216    ) -> Result<
217        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
218        conjure_http::private::Error,
219    >;
220    /// Batch update the metadata for multiple channels. If some channels cannot be found or authorized,
221    /// no metadata will be updated for any of the channels in the request.
222    #[endpoint(
223        method = POST,
224        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-update",
225        name = "batchUpdateChannelMetadata",
226        accept = conjure_http::client::StdResponseDeserializer
227    )]
228    async fn batch_update_channel_metadata(
229        &self,
230        #[auth]
231        auth_: &conjure_object::BearerToken,
232        #[body(serializer = conjure_http::client::StdRequestSerializer)]
233        request: &super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataRequest,
234    ) -> Result<
235        super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataResponse,
236        conjure_http::private::Error,
237    >;
238}
nominal_api/conjure/clients/timeseries/channelmetadata/channel_metadata_service.rs

nominal_api/conjure/clients/timeseries/channelmetadata/
channel_metadata_service.rs
