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

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