nominal-api 0.1240.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

use conjure_http::endpoint;
/// Endpoints for retrieving and updating channel metadata.
#[conjure_http::conjure_endpoints(
    name = "ChannelMetadataService",
    use_legacy_error_serialization
)]
pub trait ChannelMetadataService {
    /// Get the metadata for a channel.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/get",
        name = "getChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn get_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::GetChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
        conjure_http::private::Error,
    >;
    /// Batch get the metadata for multiple channels. If some channels cannot be found or authorized,
    /// they will be omitted from the response.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-get",
        name = "batchGetChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn batch_get_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataResponse,
        conjure_http::private::Error,
    >;
    /// Update the metadata for a channel.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/update",
        name = "updateChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn update_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::UpdateChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
        conjure_http::private::Error,
    >;
    /// Batch update the metadata for multiple channels. If some channels cannot be found or authorized,
    /// no metadata will be updated for any of the channels in the request.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-update",
        name = "batchUpdateChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn batch_update_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataResponse,
        conjure_http::private::Error,
    >;
}
/// Endpoints for retrieving and updating channel metadata.
#[conjure_http::conjure_endpoints(
    name = "ChannelMetadataService",
    use_legacy_error_serialization
)]
pub trait AsyncChannelMetadataService {
    /// Get the metadata for a channel.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/get",
        name = "getChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::GetChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
        conjure_http::private::Error,
    >;
    /// Batch get the metadata for multiple channels. If some channels cannot be found or authorized,
    /// they will be omitted from the response.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-get",
        name = "batchGetChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn batch_get_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataResponse,
        conjure_http::private::Error,
    >;
    /// Update the metadata for a channel.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/update",
        name = "updateChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn update_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::UpdateChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
        conjure_http::private::Error,
    >;
    /// Batch update the metadata for multiple channels. If some channels cannot be found or authorized,
    /// no metadata will be updated for any of the channels in the request.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-update",
        name = "batchUpdateChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn batch_update_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataResponse,
        conjure_http::private::Error,
    >;
}
/// Endpoints for retrieving and updating channel metadata.
#[conjure_http::conjure_endpoints(
    name = "ChannelMetadataService",
    use_legacy_error_serialization,
    local
)]
pub trait LocalAsyncChannelMetadataService {
    /// Get the metadata for a channel.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/get",
        name = "getChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::GetChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
        conjure_http::private::Error,
    >;
    /// Batch get the metadata for multiple channels. If some channels cannot be found or authorized,
    /// they will be omitted from the response.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-get",
        name = "batchGetChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn batch_get_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::BatchGetChannelMetadataResponse,
        conjure_http::private::Error,
    >;
    /// Update the metadata for a channel.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/update",
        name = "updateChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn update_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::UpdateChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::ChannelMetadata,
        conjure_http::private::Error,
    >;
    /// Batch update the metadata for multiple channels. If some channels cannot be found or authorized,
    /// no metadata will be updated for any of the channels in the request.
    #[endpoint(
        method = POST,
        path = "/timeseries/channel-metadata/v1/channel-metadata/batch-update",
        name = "batchUpdateChannelMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn batch_update_channel_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::channelmetadata::api::BatchUpdateChannelMetadataResponse,
        conjure_http::private::Error,
    >;
}