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

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

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