minio-rs/src/s3/client/put_object_retention.rs
Henk-Jan Lebbink 9cbb95747f
Fixed doc warnings; fixed minor issue with trait separation in append_object (#160)
* minor issues fixed: bucket and object impl trait separated

* fixed doc warnings

* added CI, docs build and docs site to the initial icons

* inline doc updated

* more doc update

* bumped versions
2025-05-28 11:43:08 -07:00

56 lines
2.2 KiB
Rust

// MinIO Rust Library for Amazon S3 Compatible Cloud Storage
// Copyright 2025 MinIO, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use super::Client;
use crate::s3::builders::PutObjectRetention;
impl Client {
/// Creates a [`PutObjectRetention`] request builder.
///
/// To execute the request, call [`SetObjectRetention::send()`](crate::s3::types::S3Api::send),
/// which returns a [`Result`] containing a [`SetObjectRetentionResponse`](crate::s3::response::PutObjectRetentionResponse).
///
/// 🛈 This operation is not supported for express buckets.
///
/// # Example
///
/// ```no_run
/// use minio::s3::Client;
/// use minio::s3::response::PutObjectRetentionResponse;
/// use minio::s3::builders::ObjectToDelete;
/// use minio::s3::types::{S3Api, RetentionMode};
/// use minio::s3::utils::utc_now;
///
/// #[tokio::main]
/// async fn main() {
/// let client: Client = Default::default(); // configure your client here
/// let retain_until_date = utc_now() + chrono::Duration::days(1);
/// let resp: PutObjectRetentionResponse = client
/// .put_object_retention("bucket-name", "object-name")
/// .retention_mode(Some(RetentionMode::GOVERNANCE))
/// .retain_until_date(Some(retain_until_date))
/// .send().await.unwrap();
/// println!("set the object retention for object '{}'", resp.object);
/// }
/// ```
pub fn put_object_retention<S1: Into<String>, S2: Into<String>>(
&self,
bucket: S1,
object: S2,
) -> PutObjectRetention {
PutObjectRetention::new(self.clone(), bucket.into(), object.into())
}
}