objectscale_client/
bucket.rs

1//
2// Copyright (c) Dell Inc., or its subsidiaries. All Rights Reserved.
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10
11//! Define the bucket details.
12//!
13use crate::client::ObjectstoreClient;
14use crate::response::get_content_text;
15use anyhow::{bail, Context as _, Result};
16use derive_builder::Builder;
17use reqwest::header::{ACCEPT, AUTHORIZATION, CONTENT_TYPE};
18use serde::{Deserialize, Serialize};
19use serde_aux::field_attributes::{deserialize_bool_from_anything, deserialize_default_from_null};
20
21#[derive(Clone, Default, Debug, Deserialize, Serialize)]
22#[serde(rename_all(serialize = "snake_case", deserialize = "camelCase"))]
23pub struct Link {
24    pub rel: String,
25    pub href: String,
26}
27
28#[derive(Clone, Default, Debug, Deserialize, Serialize)]
29#[serde(rename_all(serialize = "snake_case", deserialize = "camelCase"))]
30pub struct MinMaxGovernor {
31    pub enforce_retention: bool,
32    #[serde(deserialize_with = "deserialize_default_from_null")]
33    pub minimum_fixed_retention: i64,
34    // TODO: need to understand the default value
35    #[serde(deserialize_with = "deserialize_default_from_null")]
36    pub maximum_fixed_retention: i64,
37    #[serde(deserialize_with = "deserialize_default_from_null")]
38    pub minimum_variable_retention: i64,
39    #[serde(deserialize_with = "deserialize_default_from_null")]
40    pub maximum_variable_retention: i64,
41}
42
43#[derive(Clone, Default, Debug, Deserialize, Serialize)]
44#[serde(rename_all(serialize = "snake_case", deserialize = "camelCase"))]
45pub struct MetaData {
46    /// The meta key type
47    pub key_data_type: String,
48    /// The meta key name
49    pub key_value: String,
50    /// The meta key data type
51    pub metadata_type: String,
52}
53
54#[derive(Clone, Default, Debug, Deserialize, Serialize)]
55#[serde(rename_all(serialize = "snake_case", deserialize = "camelCase"))]
56pub struct SearchMetaData {
57    /// Getter for the enabled flag.
58    pub is_enabled: bool,
59    #[serde(deserialize_with = "deserialize_default_from_null")]
60    pub meta_data: Vec<MetaData>,
61    /// Getter for maxKeys.
62    pub max_keys: i32,
63    /// Getter for the mdTokens flag.
64    pub md_tokens: bool,
65}
66
67/// Lables for bucket.
68#[derive(Clone, Debug, Deserialize, Serialize)]
69#[serde(rename_all(serialize = "PascalCase", deserialize = "camelCase"))]
70pub struct BucketTag {
71    /// The key of a tag.
72    pub key: String,
73    /// The value of a tag.
74    pub value: String,
75}
76
77/// Buckets are object containers that are used to control access to objects. ObjectScale supports bucket-to-bucket replication of the objects within a bucket.
78#[derive(Builder, Clone, Debug, Default, Deserialize, Serialize)]
79#[builder(setter(skip))]
80#[serde(
81    rename_all(serialize = "snake_case", deserialize = "camelCase"),
82    rename(serialize = "object_bucket_create")
83)]
84pub struct Bucket {
85    /// Name assigned to this resource in ECS. The resource name is set by a user and can be changed at any time. It is not a unique identifier.
86    #[builder(setter(into))]
87    pub name: String,
88    /// Identifier that is generated by ECS when the resource is created. The resource Id is guaranteed to be unique and immutable across all virtual data centers for all time.
89    pub id: String,
90    /// Hyperlink to the details for this resource
91    pub link: Link,
92    #[builder(setter(into))]
93    /// Namespace
94    pub namespace: String,
95    pub replication: String,
96    /// "Locked" status of a bucket
97    pub locked: bool,
98    /// Bucket "file system access enabled" status
99    pub fs_acess_enabled: bool,
100    /// Bucket soft quota
101    pub soft_quota: String,
102    /// Bucket creation time
103    pub created: String,
104    /// Bucket isStaleAllowed flag
105    pub is_stale_allowed: bool,
106    /// If true Object Lock and ADO can be enabled together. See the Admin Guide for more information.
107    pub object_lock_with_ado_allowed: bool,
108    /// Bucket isStaleAllowed flag
109    pub is_tso_read_only: bool,
110    /// Default object lock retention mode
111    #[serde(deserialize_with = "deserialize_default_from_null")]
112    pub default_object_lock_retention_mode: String,
113    /// Default object lock retention years
114    #[serde(deserialize_with = "deserialize_default_from_null")]
115    pub default_object_lock_retention_years: i32,
116    /// Default object lock retention days
117    #[serde(deserialize_with = "deserialize_default_from_null")]
118    pub default_object_lock_retention_days: i32,
119    /// Default bucket retention
120    pub default_retention: i64,
121    /// Block size in GB
122    pub block_size_in_g_b: i64,
123    /// auto-commit interval
124    pub auto_commit_period: i64,
125    /// Notification size in GB
126    pub notification_size_in_g_b: i64,
127    pub block_size_in_count: i64,
128    pub notification_size_in_count: i64,
129    /// Bucket isEncryptionEnabled flag
130    #[builder(setter(skip = false), default = "false")]
131    #[serde(deserialize_with = "deserialize_bool_from_anything")]
132    pub is_encryption_enabled: bool,
133    /// Default retention value for the bucket.
134    pub retention: i64,
135    /// Bucket's default group
136    #[serde(deserialize_with = "deserialize_default_from_null")]
137    pub default_group: String,
138    /// Flag indicating the Read permission for default group
139    pub default_group_file_read_permission: bool,
140    /// Flag indicating the file write permission for default group
141    pub default_group_file_write_permission: bool,
142    /// Flag indicating the file execute permission for default group
143    pub default_group_file_execute_permission: bool,
144    /// Flag indicating the directory read permission for default group. This is only applicable to folders created within the Filesystem-Enabled bucket. It is not applicable to files/objects
145    pub default_group_dir_read_permission: bool,
146    /// Flag indicating the directory write permission for default group. This is only applicable to folders created within the Filesystem-Enabled bucket. It is not applicable to files/objects
147    pub default_group_dir_write_permission: bool,
148    /// Flag indicating the directory execute permission for default group. This is only applicable to folders created within the Filesystem-Enabled bucket. It is not applicable to files/objects
149    pub default_group_dir_execute_permission: bool,
150    pub min_max_governor: MinMaxGovernor,
151    /// Bucket audit delete expiration in seconds
152    #[builder(setter(skip = false), default = "-2")]
153    #[serde(rename(serialize = "audited_delete_expiration"))]
154    pub audit_delete_expiration: i64,
155    pub enable_advanced_metadata_search: bool,
156    #[serde(deserialize_with = "deserialize_default_from_null")]
157    pub advanced_metadata_search_target_name: String,
158    #[serde(deserialize_with = "deserialize_default_from_null")]
159    pub advanced_metadata_search_target_stream: String,
160    /// Optional. If true the bucket is in the process of being deleted. The bucket will be read only and no changes will be allowed on the bucket until the operation completes.
161    pub is_empty_bucket_in_progress: bool,
162    pub meta_data: SearchMetaData,
163    /// Local object metadata reads bucket flag.
164    pub local_object_metadata_reads: bool,
165    /// API type
166    pub apitype: String,
167    /// Bucket owner
168    pub bucket_owner: String,
169    /// Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
170    #[builder(setter(skip = false), default)]
171    #[serde(rename = "TagSet", deserialize_with = "deserialize_default_from_null")]
172    pub tags: Vec<BucketTag>,
173}
174
175// dose not deserialize all the fields for create bucket response
176// as the schema does not align with get bucket response
177// would issue get bucket request in addition after creation and send the response accordingly
178#[derive(Debug, Deserialize)]
179#[serde(rename_all = "camelCase")]
180struct CreateBucketResponse {
181    pub name: String,
182    pub id: String,
183}
184
185#[derive(Debug, Deserialize)]
186#[serde(rename_all = "camelCase")]
187struct ListBucketsResponse {
188    // Does not align with API description
189    pub object_bucket_list: Vec<Bucket>,
190    pub filter: String,
191    pub next_marker: Option<String>,
192    pub max_buckets: Option<u32>,
193    pub next_page_link: Option<String>,
194}
195
196impl Bucket {
197    pub(crate) fn create(client: &mut ObjectstoreClient, bucket: Bucket) -> Result<String> {
198        let request_url = format!("{}object/bucket.json", client.endpoint);
199        let body = quick_xml::se::to_string(&bucket)?;
200        let resp = client
201            .management_client
202            .http_client
203            .post(request_url)
204            .header(ACCEPT, "application/json")
205            .header(
206                AUTHORIZATION,
207                client.management_client.access_token.as_ref().unwrap(),
208            )
209            .header(CONTENT_TYPE, "application/xml")
210            .body(body)
211            .send()?;
212        let text = get_content_text(resp)?;
213        let resp: CreateBucketResponse = serde_json::from_str(&text).with_context(|| {
214            format!(
215                "Unable to deserialise CreateBucketResponse. Body was: \"{}\"",
216                text
217            )
218        })?;
219        Ok(resp.name)
220    }
221
222    pub(crate) fn tag(
223        client: &mut ObjectstoreClient,
224        bucket_name: &str,
225        namespace: &str,
226        tags: Vec<BucketTag>,
227    ) -> Result<()> {
228        // TODO:
229        // quick_xml dose not serialize object vector with object name
230        // serialize to string directly once https://github.com/tafia/quick-xml/pull/784 is resolved
231        let tags = tags
232            .iter()
233            .map(|tag| quick_xml::se::to_string_with_root("Tag", tag).unwrap())
234            .collect::<Vec<String>>()
235            .join("");
236        let body = format!(
237            r#"<add_bucket_tags><TagSet>{}</TagSet><namespace>{}</namespace></add_bucket_tags>"#,
238            tags, namespace
239        );
240        let request_url = format!("{}object/bucket/{}/tags", client.endpoint, bucket_name);
241        let resp = client
242            .management_client
243            .http_client
244            .post(request_url)
245            .header(ACCEPT, "application/json")
246            .header(
247                AUTHORIZATION,
248                client.management_client.access_token.as_ref().unwrap(),
249            )
250            .header(CONTENT_TYPE, "application/xml")
251            .body(body)
252            .send()?;
253        if !resp.status().is_success() {
254            bail!("Request failed: {}", resp.text()?);
255        }
256        Ok(())
257    }
258
259    pub(crate) fn get(
260        client: &mut ObjectstoreClient,
261        name: &str,
262        namespace: &str,
263    ) -> Result<Bucket> {
264        let request_url = format!(
265            "{}object/bucket/{}/info.json?namespace={}",
266            client.endpoint, name, namespace,
267        );
268        let resp = client
269            .management_client
270            .http_client
271            .get(request_url)
272            .header(ACCEPT, "application/json")
273            .header(
274                AUTHORIZATION,
275                client.management_client.access_token.as_ref().unwrap(),
276            )
277            .send()?;
278        let text = get_content_text(resp)?;
279        let resp: Bucket = serde_json::from_str(&text)
280            .with_context(|| format!("Unable to deserialise GetBucket. Body was: \"{}\"", text))?;
281        Ok(resp)
282    }
283
284    pub(crate) fn update(client: &mut ObjectstoreClient, bucket: Bucket) -> Result<()> {
285        // Set Bucket Audit Delete Expiration
286        let request_url = format!(
287            "{}object/bucket/{}/auditDeleteExpiration?expiration={}&namespace={}",
288            client.endpoint, bucket.name, bucket.audit_delete_expiration, bucket.namespace,
289        );
290        let body = quick_xml::se::to_string(&bucket)?;
291        let resp = client
292            .management_client
293            .http_client
294            .put(request_url)
295            .header(ACCEPT, "application/json")
296            .header(
297                AUTHORIZATION,
298                client.management_client.access_token.as_ref().unwrap(),
299            )
300            .body(body)
301            .send()?;
302        if !resp.status().is_success() {
303            bail!("Request failed: {}", resp.text()?);
304        }
305        Ok(())
306    }
307
308    pub(crate) fn delete(
309        client: &mut ObjectstoreClient,
310        name: &str,
311        namespace: &str,
312        empty_bucket: bool,
313    ) -> Result<()> {
314        let request_url = format!(
315            "{}object/bucket/{}/deactivate.json?namespace={}&emptyBucket={}",
316            client.endpoint, name, namespace, empty_bucket,
317        );
318        let resp = client
319            .management_client
320            .http_client
321            .post(request_url)
322            .header(ACCEPT, "application/json")
323            .header(
324                AUTHORIZATION,
325                client.management_client.access_token.as_ref().unwrap(),
326            )
327            .send()?;
328        if !resp.status().is_success() {
329            bail!("Request failed: {}", resp.text()?);
330        } else if resp.status().as_u16() == 202 {
331            // TODO: whether to check response
332            // it may last for a while
333            bail!("Deletion ongoing");
334        } else {
335            Ok(())
336        }
337    }
338
339    pub(crate) fn list(
340        client: &mut ObjectstoreClient,
341        namespace: &str,
342        name_prefix: &str,
343    ) -> Result<Vec<Bucket>> {
344        let prefix = if name_prefix.is_empty() {
345            "".to_string()
346        } else {
347            format!("&name={}", name_prefix)
348        };
349        let request_url = format!(
350            "{}object/bucket.json?namespace={}{}",
351            client.endpoint, namespace, prefix,
352        );
353        let resp = client
354            .management_client
355            .http_client
356            .get(request_url)
357            .header(ACCEPT, "application/json")
358            .header(
359                AUTHORIZATION,
360                client.management_client.access_token.as_ref().unwrap(),
361            )
362            .send()?;
363        let text = get_content_text(resp)?;
364        let mut resp: ListBucketsResponse = serde_json::from_str(&text).with_context(|| {
365            format!(
366                "Unable to deserialise ListBuckestResponse. Body was: \"{}\"",
367                text
368            )
369        })?;
370        let mut buckets: Vec<Bucket> = vec![];
371        buckets.extend(resp.object_bucket_list);
372        while let Some(marker) = resp.next_marker {
373            let request_url = format!(
374                "{}object/bucket.json?namespace={}{}&marker={}",
375                client.endpoint, namespace, prefix, marker,
376            );
377            let response = client
378                .management_client
379                .http_client
380                .get(request_url)
381                .header(ACCEPT, "application/json")
382                .header(
383                    AUTHORIZATION,
384                    client.management_client.access_token.as_ref().unwrap(),
385                )
386                .send()?;
387            let text = get_content_text(response)?;
388            resp = serde_json::from_str(&text).with_context(|| {
389                format!(
390                    "Unable to deserialise ListBucketsResponse. Body was: \"{}\"",
391                    text
392                )
393            })?;
394            buckets.extend(resp.object_bucket_list);
395        }
396        Ok(buckets)
397    }
398}
objectscale_client/bucket.rs

objectscale_client/
bucket.rs
