scienceobjectsdb_rust_api 0.3.0-alpha.1

The Rust API build for the ScienceObjectsDB
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Location {
    #[prost(message, optional, tag="1")]
    pub object_location: ::core::option::Option<ObjectLocation>,
}
/// A location in S3
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ObjectLocation {
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
    #[prost(string, tag="2")]
    pub bucket: ::prost::alloc::string::String,
    #[prost(string, tag="3")]
    pub key: ::prost::alloc::string::String,
    /// Object storage endpoint
    #[prost(string, tag="4")]
    pub url: ::prost::alloc::string::String,
    #[prost(enumeration="Status", tag="5")]
    pub status: i32,
    #[prost(string, tag="6")]
    pub upload_id: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Index {
    #[prost(int64, tag="1")]
    pub start_byte: i64,
    #[prost(int64, tag="2")]
    pub end_byte: i64,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Origin {
    #[prost(string, tag="1")]
    pub link: ::prost::alloc::string::String,
    #[prost(enumeration="origin::OriginType", tag="3")]
    pub origin_type: i32,
    #[prost(oneof="origin::Location", tags="2")]
    pub location: ::core::option::Option<origin::Location>,
}
/// Nested message and enum types in `Origin`.
pub mod origin {
    #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
    #[repr(i32)]
    pub enum OriginType {
        Unspecified = 0,
        ObjectStorage = 1,
        OriginLink = 2,
    }
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Location {
        #[prost(message, tag="2")]
        ObjectLocation(super::ObjectLocation),
    }
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Version {
    #[prost(int32, tag="1")]
    pub major: i32,
    #[prost(int32, tag="2")]
    pub minor: i32,
    #[prost(int32, tag="3")]
    pub patch: i32,
    #[prost(int32, tag="4")]
    pub revision: i32,
    #[prost(enumeration="version::VersionStage", tag="5")]
    pub stage: i32,
}
/// Nested message and enum types in `Version`.
pub mod version {
    #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
    #[repr(i32)]
    pub enum VersionStage {
        Unspecified = 0,
        Stable = 1,
        Rc = 2,
        Beta = 3,
        Alpha = 4,
    }
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Label {
    #[prost(string, tag="1")]
    pub key: ::prost::alloc::string::String,
    #[prost(string, tag="2")]
    pub value: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Annotation {
    #[prost(string, tag="1")]
    pub key: ::prost::alloc::string::String,
    #[prost(string, tag="2")]
    pub value: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Id {
    /// An arbitrary ID
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFieldsRequest {
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
    #[prost(map="string, string", tag="2")]
    pub updated_string_fields: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct User {
    #[prost(string, tag="1")]
    pub user_id: ::prost::alloc::string::String,
    #[prost(enumeration="Right", repeated, tag="2")]
    pub rights: ::prost::alloc::vec::Vec<i32>,
    #[prost(enumeration="Resource", tag="3")]
    pub resource: i32,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VersionTag {
    #[prost(string, tag="1")]
    pub name: ::prost::alloc::string::String,
    #[prost(string, tag="2")]
    pub version_id: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ApiToken {
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
    #[prost(string, tag="2")]
    pub token: ::prost::alloc::string::String,
    #[prost(enumeration="Right", repeated, tag="3")]
    pub rights: ::prost::alloc::vec::Vec<i32>,
    #[prost(string, tag="4")]
    pub project_id: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Empty {
}
/// Request for paginated result retrival
/// If the page size is zero, the backends default page size will be used
/// If the page size exceeds the backends maximum, an error will be returned
/// Consistency of results will only be guaranteed for DatasetVersions
/// For the initial request leave last_uuid empty
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PageRequest {
    #[prost(string, tag="1")]
    pub last_uuid: ::prost::alloc::string::String,
    #[prost(uint64, tag="2")]
    pub page_size: u64,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Status {
    Unspecified = 0,
    Initiating = 1,
    Available = 2,
    Updating = 3,
    Archived = 4,
    Deleting = 5,
    Staging = 6,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Right {
    Unspecified = 0,
    Read = 1,
    Write = 2,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Resource {
    Unspecified = 0,
    Project = 1,
    Dataset = 2,
    DatasetVersion = 3,
    Object = 4,
    ObjectGroup = 5,
    ObjectGroupRevision = 6,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ObjectGroup {
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
    #[prost(int64, tag="2")]
    pub revision_counter: i64,
    #[prost(message, optional, tag="3")]
    pub current_revision: ::core::option::Option<ObjectGroupRevision>,
    #[prost(string, tag="4")]
    pub dataset_id: ::prost::alloc::string::String,
    #[prost(string, tag="5")]
    pub project_id: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ObjectGroupRevision {
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
    #[prost(string, tag="2")]
    pub name: ::prost::alloc::string::String,
    #[prost(string, tag="3")]
    pub description: ::prost::alloc::string::String,
    #[prost(string, tag="4")]
    pub dataset_id: ::prost::alloc::string::String,
    #[prost(string, tag="5")]
    pub project_id: ::prost::alloc::string::String,
    #[prost(message, repeated, tag="6")]
    pub labels: ::prost::alloc::vec::Vec<Label>,
    #[prost(message, repeated, tag="7")]
    pub annotations: ::prost::alloc::vec::Vec<Annotation>,
    #[prost(enumeration="Status", tag="8")]
    pub status: i32,
    #[prost(message, repeated, tag="9")]
    pub objects: ::prost::alloc::vec::Vec<Object>,
    #[prost(message, repeated, tag="10")]
    pub metadata_objects: ::prost::alloc::vec::Vec<Object>,
    #[prost(message, optional, tag="11")]
    pub generated: ::core::option::Option<::prost_types::Timestamp>,
    #[prost(message, optional, tag="12")]
    pub created: ::core::option::Option<::prost_types::Timestamp>,
    #[prost(message, optional, tag="13")]
    pub stats: ::core::option::Option<ObjectGroupStats>,
    /// Expected external path; Can be used when downloading data; Should be a relative path
    #[prost(message, optional, tag="15")]
    pub subpath: ::core::option::Option<Subpath>,
    #[prost(string, tag="16")]
    pub object_group_id: ::prost::alloc::string::String,
    ///Number in the history, will be assigned after the ObjectGroupRevision has been finalized
    #[prost(int64, tag="17")]
    pub revision_number: i64,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ObjectGroupStats {
    #[prost(int64, tag="1")]
    pub object_count: i64,
    #[prost(int64, tag="2")]
    pub acc_size: i64,
    #[prost(double, tag="3")]
    pub avg_object_size: f64,
    #[prost(int64, tag="4")]
    pub meta_object_count: i64,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Object {
    ///ID of the entity
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
    /// Filename: Name of the original file e.g.: mydata.json
    #[prost(string, tag="2")]
    pub filename: ::prost::alloc::string::String,
    /// Filetype: The specific type of the file, which can be the combination of a format like json and a specific schema (e.g. mzML using XML format and a specific schema)
    #[prost(string, tag="3")]
    pub filetype: ::prost::alloc::string::String,
    #[prost(message, repeated, tag="4")]
    pub labels: ::prost::alloc::vec::Vec<Label>,
    #[prost(message, repeated, tag="5")]
    pub annotations: ::prost::alloc::vec::Vec<Annotation>,
    /// When the data object was created
    #[prost(message, optional, tag="6")]
    pub created: ::core::option::Option<::prost_types::Timestamp>,
    /// Location: Location of the data
    #[prost(message, repeated, tag="7")]
    pub locations: ::prost::alloc::vec::Vec<Location>,
    #[prost(message, optional, tag="18")]
    pub default_location: ::core::option::Option<Location>,
    /// Origin: Source of the dataset
    #[prost(message, optional, tag="8")]
    pub origin: ::core::option::Option<Origin>,
    /// ContentLen: Lenght of the stored dataset
    #[prost(int64, tag="9")]
    pub content_len: i64,
    #[prost(message, optional, tag="11")]
    pub generated: ::core::option::Option<::prost_types::Timestamp>,
    #[prost(string, tag="12")]
    pub object_group_id: ::prost::alloc::string::String,
    #[prost(string, tag="13")]
    pub dataset_id: ::prost::alloc::string::String,
    #[prost(string, tag="14")]
    pub project_id: ::prost::alloc::string::String,
    #[prost(enumeration="Status", tag="15")]
    pub status: i32,
    #[prost(message, optional, tag="16")]
    pub stats: ::core::option::Option<ObjectStats>,
    /// Fileformat: Format of the stored file, e.g.: json, csv,...
    #[prost(string, tag="17")]
    pub fileformat: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ObjectStats {
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Subpath {
    #[prost(string, tag="1")]
    pub path: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Dataset {
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
    /// Name of the dataset
    #[prost(string, tag="2")]
    pub name: ::prost::alloc::string::String,
    #[prost(string, tag="3")]
    pub description: ::prost::alloc::string::String,
    /// When the datasets was created
    #[prost(message, optional, tag="4")]
    pub created: ::core::option::Option<::prost_types::Timestamp>,
    #[prost(message, repeated, tag="5")]
    pub labels: ::prost::alloc::vec::Vec<Label>,
    #[prost(message, repeated, tag="6")]
    pub annotations: ::prost::alloc::vec::Vec<Annotation>,
    #[prost(string, tag="7")]
    pub project_id: ::prost::alloc::string::String,
    ///Indicates if the dataset if publicly available
    #[prost(bool, tag="8")]
    pub is_public: bool,
    #[prost(enumeration="Status", tag="9")]
    pub status: i32,
    #[prost(string, tag="10")]
    pub bucket: ::prost::alloc::string::String,
    #[prost(message, optional, tag="11")]
    pub stats: ::core::option::Option<DatasetStats>,
    #[prost(message, repeated, tag="12")]
    pub metadata_objects: ::prost::alloc::vec::Vec<Object>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DatasetVersion {
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
    #[prost(string, tag="2")]
    pub name: ::prost::alloc::string::String,
    #[prost(string, tag="3")]
    pub description: ::prost::alloc::string::String,
    #[prost(string, tag="4")]
    pub dataset_id: ::prost::alloc::string::String,
    #[prost(message, repeated, tag="5")]
    pub labels: ::prost::alloc::vec::Vec<Label>,
    #[prost(message, repeated, tag="6")]
    pub annotations: ::prost::alloc::vec::Vec<Annotation>,
    /// When the datasets version was created
    #[prost(message, optional, tag="7")]
    pub created: ::core::option::Option<::prost_types::Timestamp>,
    #[prost(message, optional, tag="8")]
    pub version: ::core::option::Option<Version>,
    #[prost(string, repeated, tag="9")]
    pub object_group_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
    /// Number of objects registered with this dataset version
    #[prost(int64, tag="10")]
    pub object_count: i64,
    /// Indicates the status of a dataset
    #[prost(enumeration="Status", tag="11")]
    pub status: i32,
    #[prost(string, tag="12")]
    pub project_id: ::prost::alloc::string::String,
    #[prost(message, optional, tag="13")]
    pub stats: ::core::option::Option<DatasetVersionStats>,
    #[prost(message, repeated, tag="14")]
    pub metadata_objects: ::prost::alloc::vec::Vec<Object>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DatasetStats {
    #[prost(int64, tag="1")]
    pub object_count: i64,
    #[prost(int64, tag="2")]
    pub object_group_count: i64,
    #[prost(int64, tag="3")]
    pub acc_size: i64,
    #[prost(double, tag="4")]
    pub avg_object_size: f64,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DatasetVersionStats {
    #[prost(int64, tag="1")]
    pub object_count: i64,
    #[prost(int64, tag="2")]
    pub object_group_count: i64,
    #[prost(int64, tag="3")]
    pub acc_size: i64,
    #[prost(double, tag="4")]
    pub avg_object_size: f64,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Project {
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
    #[prost(string, tag="2")]
    pub name: ::prost::alloc::string::String,
    #[prost(string, tag="3")]
    pub description: ::prost::alloc::string::String,
    #[prost(message, repeated, tag="4")]
    pub labels: ::prost::alloc::vec::Vec<Label>,
    #[prost(message, repeated, tag="5")]
    pub annotations: ::prost::alloc::vec::Vec<Annotation>,
    #[prost(message, repeated, tag="6")]
    pub users: ::prost::alloc::vec::Vec<User>,
    #[prost(string, tag="7")]
    pub bucket: ::prost::alloc::string::String,
    #[prost(enumeration="Status", tag="8")]
    pub status: i32,
    #[prost(message, optional, tag="9")]
    pub stats: ::core::option::Option<ProjectStats>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProjectStats {
    #[prost(int64, tag="1")]
    pub object_count: i64,
    #[prost(int64, tag="2")]
    pub object_group_count: i64,
    #[prost(int64, tag="3")]
    pub acc_size: i64,
    #[prost(double, tag="4")]
    pub avg_object_size: f64,
    #[prost(int64, tag="5")]
    pub user_count: i64,
}