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
// 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 crate::s3::client::MinioClient;
use crate::s3::error::ValidationErr;
use crate::s3::multimap_ext::{Multimap, MultimapExt};
use crate::s3::response::GetObjectRetentionResponse;
use crate::s3::types::{BucketName, ObjectKey, Region, S3Api, S3Request, ToS3Request, VersionId};
use crate::s3::utils::insert;
use http::Method;
use typed_builder::TypedBuilder;
/// Argument builder for the [`GetObjectRetention`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html) S3 API operation.
///
/// This struct constructs the parameters required for the [`Client::get_object_retention`](crate::s3::client::MinioClient::get_object_retention) method.
#[derive(Clone, Debug, TypedBuilder)]
pub struct GetObjectRetention {
#[builder(!default)] // force required
client: MinioClient,
#[builder(default, setter(into))]
extra_headers: Option<Multimap>,
#[builder(default, setter(into))]
extra_query_params: Option<Multimap>,
#[builder(default, setter(into))]
region: Option<Region>,
#[builder(setter(into), !default)]
bucket: BucketName,
#[builder(setter(into), !default)]
object: ObjectKey,
#[builder(default, setter(into))]
version_id: Option<VersionId>,
}
/// Builder type alias for [`GetObjectRetention`].
///
/// Constructed via [`GetObjectRetention::builder()`](GetObjectRetention::builder) and used to build a [`GetObjectRetention`] instance.
pub type GetObjectRetentionBldr =
GetObjectRetentionBuilder<((MinioClient,), (), (), (), (BucketName,), (ObjectKey,), ())>;
impl S3Api for GetObjectRetention {
type S3Response = GetObjectRetentionResponse;
}
impl ToS3Request for GetObjectRetention {
fn to_s3request(self) -> Result<S3Request, ValidationErr> {
let mut query_params: Multimap = insert(self.extra_query_params, "retention");
query_params.add_version(self.version_id);
Ok(S3Request::builder()
.client(self.client)
.method(Method::GET)
.region(self.region)
.bucket(self.bucket)
.query_params(query_params)
.object(self.object)
.headers(self.extra_headers.unwrap_or_default())
.build())
}
}