nominal_api/conjure/endpoints/timeseries/seriescache/
series_cache_service.rs

1use conjure_http::endpoint;
2/// The Series Cache service manages internal chunks of data cached by Nominal's backend.
3#[conjure_http::conjure_endpoints(
4    name = "SeriesCacheService",
5    use_legacy_error_serialization
6)]
7pub trait SeriesCacheService {
8    /// Fetches "chunks" of series that are stored as Arrow files in S3.
9    /// This endpoint is being deprecated for new series in favor of batchGetCachedSeries
10    #[endpoint(
11        method = POST,
12        path = "/timeseries/series-cache/v1/logical-series/{logicalSeriesRid}/get-chunks",
13        name = "getChunks",
14        produces = conjure_http::server::StdResponseSerializer
15    )]
16    fn get_chunks(
17        &self,
18        #[auth]
19        auth_: conjure_object::BearerToken,
20        #[path(
21            name = "logicalSeriesRid",
22            decoder = conjure_http::server::conjure::FromPlainDecoder,
23            log_as = "logicalSeriesRid"
24        )]
25        logical_series_rid: conjure_object::ResourceIdentifier,
26        #[body(
27            deserializer = conjure_http::server::StdRequestDeserializer,
28            log_as = "getChunksParameters"
29        )]
30        get_chunks_parameters: super::super::super::super::objects::timeseries::seriescache::api::GetChunksParameters,
31    ) -> Result<
32        super::super::super::super::objects::timeseries::seriescache::api::GetChunksResponse,
33        conjure_http::private::Error,
34    >;
35    #[endpoint(
36        method = POST,
37        path = "/timeseries/series-cache/v1/logical-series/{logicalSeriesRid}/create-chunks",
38        name = "createChunks",
39        produces = conjure_http::server::StdResponseSerializer
40    )]
41    fn create_chunks(
42        &self,
43        #[auth]
44        auth_: conjure_object::BearerToken,
45        #[path(
46            name = "logicalSeriesRid",
47            decoder = conjure_http::server::conjure::FromPlainDecoder,
48            log_as = "logicalSeriesRid"
49        )]
50        logical_series_rid: conjure_object::ResourceIdentifier,
51        #[body(
52            deserializer = conjure_http::server::StdRequestDeserializer,
53            log_as = "createChunksParameters"
54        )]
55        create_chunks_parameters: super::super::super::super::objects::timeseries::seriescache::api::CreateChunksParameters,
56    ) -> Result<
57        super::super::super::super::objects::timeseries::seriescache::api::CreateChunksResponse,
58        conjure_http::private::Error,
59    >;
60    #[endpoint(
61        method = POST,
62        path = "/timeseries/series-cache/v1/batch-create-chunks",
63        name = "batchCreateChunks",
64        produces = conjure_http::server::StdResponseSerializer
65    )]
66    fn batch_create_chunks(
67        &self,
68        #[auth]
69        auth_: conjure_object::BearerToken,
70        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
71        request: super::super::super::super::objects::timeseries::seriescache::api::CreateChunksParameters,
72    ) -> Result<
73        super::super::super::super::objects::timeseries::seriescache::api::CreateChunksResponse,
74        conjure_http::private::Error,
75    >;
76    /// Deletes the chunks that intersect the given time range. Does not delete the corresponding files from S3.
77    #[endpoint(
78        method = POST,
79        path = "/timeseries/series-cache/v1/logical-series/{logicalSeriesRid}/delete-chunks",
80        name = "deleteChunks",
81        produces = conjure_http::server::StdResponseSerializer
82    )]
83    fn delete_chunks(
84        &self,
85        #[auth]
86        auth_: conjure_object::BearerToken,
87        #[path(
88            name = "logicalSeriesRid",
89            decoder = conjure_http::server::conjure::FromPlainDecoder,
90            log_as = "logicalSeriesRid"
91        )]
92        logical_series_rid: conjure_object::ResourceIdentifier,
93        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
94        request: super::super::super::super::objects::timeseries::seriescache::api::DeleteChunksParameters,
95    ) -> Result<
96        super::super::super::super::objects::timeseries::seriescache::api::DeleteChunksResponse,
97        conjure_http::private::Error,
98    >;
99}
100/// The Series Cache service manages internal chunks of data cached by Nominal's backend.
101#[conjure_http::conjure_endpoints(
102    name = "SeriesCacheService",
103    use_legacy_error_serialization
104)]
105pub trait AsyncSeriesCacheService {
106    /// Fetches "chunks" of series that are stored as Arrow files in S3.
107    /// This endpoint is being deprecated for new series in favor of batchGetCachedSeries
108    #[endpoint(
109        method = POST,
110        path = "/timeseries/series-cache/v1/logical-series/{logicalSeriesRid}/get-chunks",
111        name = "getChunks",
112        produces = conjure_http::server::StdResponseSerializer
113    )]
114    async fn get_chunks(
115        &self,
116        #[auth]
117        auth_: conjure_object::BearerToken,
118        #[path(
119            name = "logicalSeriesRid",
120            decoder = conjure_http::server::conjure::FromPlainDecoder,
121            log_as = "logicalSeriesRid"
122        )]
123        logical_series_rid: conjure_object::ResourceIdentifier,
124        #[body(
125            deserializer = conjure_http::server::StdRequestDeserializer,
126            log_as = "getChunksParameters"
127        )]
128        get_chunks_parameters: super::super::super::super::objects::timeseries::seriescache::api::GetChunksParameters,
129    ) -> Result<
130        super::super::super::super::objects::timeseries::seriescache::api::GetChunksResponse,
131        conjure_http::private::Error,
132    >;
133    #[endpoint(
134        method = POST,
135        path = "/timeseries/series-cache/v1/logical-series/{logicalSeriesRid}/create-chunks",
136        name = "createChunks",
137        produces = conjure_http::server::StdResponseSerializer
138    )]
139    async fn create_chunks(
140        &self,
141        #[auth]
142        auth_: conjure_object::BearerToken,
143        #[path(
144            name = "logicalSeriesRid",
145            decoder = conjure_http::server::conjure::FromPlainDecoder,
146            log_as = "logicalSeriesRid"
147        )]
148        logical_series_rid: conjure_object::ResourceIdentifier,
149        #[body(
150            deserializer = conjure_http::server::StdRequestDeserializer,
151            log_as = "createChunksParameters"
152        )]
153        create_chunks_parameters: super::super::super::super::objects::timeseries::seriescache::api::CreateChunksParameters,
154    ) -> Result<
155        super::super::super::super::objects::timeseries::seriescache::api::CreateChunksResponse,
156        conjure_http::private::Error,
157    >;
158    #[endpoint(
159        method = POST,
160        path = "/timeseries/series-cache/v1/batch-create-chunks",
161        name = "batchCreateChunks",
162        produces = conjure_http::server::StdResponseSerializer
163    )]
164    async fn batch_create_chunks(
165        &self,
166        #[auth]
167        auth_: conjure_object::BearerToken,
168        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
169        request: super::super::super::super::objects::timeseries::seriescache::api::CreateChunksParameters,
170    ) -> Result<
171        super::super::super::super::objects::timeseries::seriescache::api::CreateChunksResponse,
172        conjure_http::private::Error,
173    >;
174    /// Deletes the chunks that intersect the given time range. Does not delete the corresponding files from S3.
175    #[endpoint(
176        method = POST,
177        path = "/timeseries/series-cache/v1/logical-series/{logicalSeriesRid}/delete-chunks",
178        name = "deleteChunks",
179        produces = conjure_http::server::StdResponseSerializer
180    )]
181    async fn delete_chunks(
182        &self,
183        #[auth]
184        auth_: conjure_object::BearerToken,
185        #[path(
186            name = "logicalSeriesRid",
187            decoder = conjure_http::server::conjure::FromPlainDecoder,
188            log_as = "logicalSeriesRid"
189        )]
190        logical_series_rid: conjure_object::ResourceIdentifier,
191        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
192        request: super::super::super::super::objects::timeseries::seriescache::api::DeleteChunksParameters,
193    ) -> Result<
194        super::super::super::super::objects::timeseries::seriescache::api::DeleteChunksResponse,
195        conjure_http::private::Error,
196    >;
197}
198/// The Series Cache service manages internal chunks of data cached by Nominal's backend.
199#[conjure_http::conjure_endpoints(
200    name = "SeriesCacheService",
201    use_legacy_error_serialization,
202    local
203)]
204pub trait LocalAsyncSeriesCacheService {
205    /// Fetches "chunks" of series that are stored as Arrow files in S3.
206    /// This endpoint is being deprecated for new series in favor of batchGetCachedSeries
207    #[endpoint(
208        method = POST,
209        path = "/timeseries/series-cache/v1/logical-series/{logicalSeriesRid}/get-chunks",
210        name = "getChunks",
211        produces = conjure_http::server::StdResponseSerializer
212    )]
213    async fn get_chunks(
214        &self,
215        #[auth]
216        auth_: conjure_object::BearerToken,
217        #[path(
218            name = "logicalSeriesRid",
219            decoder = conjure_http::server::conjure::FromPlainDecoder,
220            log_as = "logicalSeriesRid"
221        )]
222        logical_series_rid: conjure_object::ResourceIdentifier,
223        #[body(
224            deserializer = conjure_http::server::StdRequestDeserializer,
225            log_as = "getChunksParameters"
226        )]
227        get_chunks_parameters: super::super::super::super::objects::timeseries::seriescache::api::GetChunksParameters,
228    ) -> Result<
229        super::super::super::super::objects::timeseries::seriescache::api::GetChunksResponse,
230        conjure_http::private::Error,
231    >;
232    #[endpoint(
233        method = POST,
234        path = "/timeseries/series-cache/v1/logical-series/{logicalSeriesRid}/create-chunks",
235        name = "createChunks",
236        produces = conjure_http::server::StdResponseSerializer
237    )]
238    async fn create_chunks(
239        &self,
240        #[auth]
241        auth_: conjure_object::BearerToken,
242        #[path(
243            name = "logicalSeriesRid",
244            decoder = conjure_http::server::conjure::FromPlainDecoder,
245            log_as = "logicalSeriesRid"
246        )]
247        logical_series_rid: conjure_object::ResourceIdentifier,
248        #[body(
249            deserializer = conjure_http::server::StdRequestDeserializer,
250            log_as = "createChunksParameters"
251        )]
252        create_chunks_parameters: super::super::super::super::objects::timeseries::seriescache::api::CreateChunksParameters,
253    ) -> Result<
254        super::super::super::super::objects::timeseries::seriescache::api::CreateChunksResponse,
255        conjure_http::private::Error,
256    >;
257    #[endpoint(
258        method = POST,
259        path = "/timeseries/series-cache/v1/batch-create-chunks",
260        name = "batchCreateChunks",
261        produces = conjure_http::server::StdResponseSerializer
262    )]
263    async fn batch_create_chunks(
264        &self,
265        #[auth]
266        auth_: conjure_object::BearerToken,
267        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
268        request: super::super::super::super::objects::timeseries::seriescache::api::CreateChunksParameters,
269    ) -> Result<
270        super::super::super::super::objects::timeseries::seriescache::api::CreateChunksResponse,
271        conjure_http::private::Error,
272    >;
273    /// Deletes the chunks that intersect the given time range. Does not delete the corresponding files from S3.
274    #[endpoint(
275        method = POST,
276        path = "/timeseries/series-cache/v1/logical-series/{logicalSeriesRid}/delete-chunks",
277        name = "deleteChunks",
278        produces = conjure_http::server::StdResponseSerializer
279    )]
280    async fn delete_chunks(
281        &self,
282        #[auth]
283        auth_: conjure_object::BearerToken,
284        #[path(
285            name = "logicalSeriesRid",
286            decoder = conjure_http::server::conjure::FromPlainDecoder,
287            log_as = "logicalSeriesRid"
288        )]
289        logical_series_rid: conjure_object::ResourceIdentifier,
290        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
291        request: super::super::super::super::objects::timeseries::seriescache::api::DeleteChunksParameters,
292    ) -> Result<
293        super::super::super::super::objects::timeseries::seriescache::api::DeleteChunksResponse,
294        conjure_http::private::Error,
295    >;
296}
nominal_api/conjure/endpoints/timeseries/seriescache/series_cache_service.rs

nominal_api/conjure/endpoints/timeseries/seriescache/
series_cache_service.rs
