aws_sdk_backupstorage/operation/notify_object_complete/
_notify_object_complete_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::fmt::Debug)]
5pub struct NotifyObjectCompleteInput {
6    /// Backup job Id for the in-progress backup
7    pub backup_job_id: ::std::option::Option<::std::string::String>,
8    /// Upload Id for the in-progress upload
9    pub upload_id: ::std::option::Option<::std::string::String>,
10    /// Object checksum
11    pub object_checksum: ::std::option::Option<::std::string::String>,
12    /// Checksum algorithm
13    pub object_checksum_algorithm: ::std::option::Option<crate::types::SummaryChecksumAlgorithm>,
14    /// Optional metadata associated with an Object. Maximum string length is 256 bytes.
15    pub metadata_string: ::std::option::Option<::std::string::String>,
16    /// Optional metadata associated with an Object. Maximum length is 4MB.
17    pub metadata_blob: ::aws_smithy_types::byte_stream::ByteStream,
18    /// The size of MetadataBlob.
19    pub metadata_blob_length: ::std::option::Option<i64>,
20    /// Checksum of MetadataBlob.
21    pub metadata_blob_checksum: ::std::option::Option<::std::string::String>,
22    /// Checksum algorithm.
23    pub metadata_blob_checksum_algorithm: ::std::option::Option<crate::types::DataChecksumAlgorithm>,
24}
25impl NotifyObjectCompleteInput {
26    /// Backup job Id for the in-progress backup
27    pub fn backup_job_id(&self) -> ::std::option::Option<&str> {
28        self.backup_job_id.as_deref()
29    }
30    /// Upload Id for the in-progress upload
31    pub fn upload_id(&self) -> ::std::option::Option<&str> {
32        self.upload_id.as_deref()
33    }
34    /// Object checksum
35    pub fn object_checksum(&self) -> ::std::option::Option<&str> {
36        self.object_checksum.as_deref()
37    }
38    /// Checksum algorithm
39    pub fn object_checksum_algorithm(&self) -> ::std::option::Option<&crate::types::SummaryChecksumAlgorithm> {
40        self.object_checksum_algorithm.as_ref()
41    }
42    /// Optional metadata associated with an Object. Maximum string length is 256 bytes.
43    pub fn metadata_string(&self) -> ::std::option::Option<&str> {
44        self.metadata_string.as_deref()
45    }
46    /// Optional metadata associated with an Object. Maximum length is 4MB.
47    pub fn metadata_blob(&self) -> &::aws_smithy_types::byte_stream::ByteStream {
48        &self.metadata_blob
49    }
50    /// The size of MetadataBlob.
51    pub fn metadata_blob_length(&self) -> ::std::option::Option<i64> {
52        self.metadata_blob_length
53    }
54    /// Checksum of MetadataBlob.
55    pub fn metadata_blob_checksum(&self) -> ::std::option::Option<&str> {
56        self.metadata_blob_checksum.as_deref()
57    }
58    /// Checksum algorithm.
59    pub fn metadata_blob_checksum_algorithm(&self) -> ::std::option::Option<&crate::types::DataChecksumAlgorithm> {
60        self.metadata_blob_checksum_algorithm.as_ref()
61    }
62}
63impl NotifyObjectCompleteInput {
64    /// Creates a new builder-style object to manufacture [`NotifyObjectCompleteInput`](crate::operation::notify_object_complete::NotifyObjectCompleteInput).
65    pub fn builder() -> crate::operation::notify_object_complete::builders::NotifyObjectCompleteInputBuilder {
66        crate::operation::notify_object_complete::builders::NotifyObjectCompleteInputBuilder::default()
67    }
68}
69
70/// A builder for [`NotifyObjectCompleteInput`](crate::operation::notify_object_complete::NotifyObjectCompleteInput).
71#[non_exhaustive]
72#[derive(::std::default::Default, ::std::fmt::Debug)]
73pub struct NotifyObjectCompleteInputBuilder {
74    pub(crate) backup_job_id: ::std::option::Option<::std::string::String>,
75    pub(crate) upload_id: ::std::option::Option<::std::string::String>,
76    pub(crate) object_checksum: ::std::option::Option<::std::string::String>,
77    pub(crate) object_checksum_algorithm: ::std::option::Option<crate::types::SummaryChecksumAlgorithm>,
78    pub(crate) metadata_string: ::std::option::Option<::std::string::String>,
79    pub(crate) metadata_blob: ::std::option::Option<::aws_smithy_types::byte_stream::ByteStream>,
80    pub(crate) metadata_blob_length: ::std::option::Option<i64>,
81    pub(crate) metadata_blob_checksum: ::std::option::Option<::std::string::String>,
82    pub(crate) metadata_blob_checksum_algorithm: ::std::option::Option<crate::types::DataChecksumAlgorithm>,
83}
84impl NotifyObjectCompleteInputBuilder {
85    /// Backup job Id for the in-progress backup
86    /// This field is required.
87    pub fn backup_job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
88        self.backup_job_id = ::std::option::Option::Some(input.into());
89        self
90    }
91    /// Backup job Id for the in-progress backup
92    pub fn set_backup_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
93        self.backup_job_id = input;
94        self
95    }
96    /// Backup job Id for the in-progress backup
97    pub fn get_backup_job_id(&self) -> &::std::option::Option<::std::string::String> {
98        &self.backup_job_id
99    }
100    /// Upload Id for the in-progress upload
101    /// This field is required.
102    pub fn upload_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
103        self.upload_id = ::std::option::Option::Some(input.into());
104        self
105    }
106    /// Upload Id for the in-progress upload
107    pub fn set_upload_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
108        self.upload_id = input;
109        self
110    }
111    /// Upload Id for the in-progress upload
112    pub fn get_upload_id(&self) -> &::std::option::Option<::std::string::String> {
113        &self.upload_id
114    }
115    /// Object checksum
116    /// This field is required.
117    pub fn object_checksum(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
118        self.object_checksum = ::std::option::Option::Some(input.into());
119        self
120    }
121    /// Object checksum
122    pub fn set_object_checksum(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
123        self.object_checksum = input;
124        self
125    }
126    /// Object checksum
127    pub fn get_object_checksum(&self) -> &::std::option::Option<::std::string::String> {
128        &self.object_checksum
129    }
130    /// Checksum algorithm
131    /// This field is required.
132    pub fn object_checksum_algorithm(mut self, input: crate::types::SummaryChecksumAlgorithm) -> Self {
133        self.object_checksum_algorithm = ::std::option::Option::Some(input);
134        self
135    }
136    /// Checksum algorithm
137    pub fn set_object_checksum_algorithm(mut self, input: ::std::option::Option<crate::types::SummaryChecksumAlgorithm>) -> Self {
138        self.object_checksum_algorithm = input;
139        self
140    }
141    /// Checksum algorithm
142    pub fn get_object_checksum_algorithm(&self) -> &::std::option::Option<crate::types::SummaryChecksumAlgorithm> {
143        &self.object_checksum_algorithm
144    }
145    /// Optional metadata associated with an Object. Maximum string length is 256 bytes.
146    pub fn metadata_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
147        self.metadata_string = ::std::option::Option::Some(input.into());
148        self
149    }
150    /// Optional metadata associated with an Object. Maximum string length is 256 bytes.
151    pub fn set_metadata_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
152        self.metadata_string = input;
153        self
154    }
155    /// Optional metadata associated with an Object. Maximum string length is 256 bytes.
156    pub fn get_metadata_string(&self) -> &::std::option::Option<::std::string::String> {
157        &self.metadata_string
158    }
159    /// Optional metadata associated with an Object. Maximum length is 4MB.
160    pub fn metadata_blob(mut self, input: ::aws_smithy_types::byte_stream::ByteStream) -> Self {
161        self.metadata_blob = ::std::option::Option::Some(input);
162        self
163    }
164    /// Optional metadata associated with an Object. Maximum length is 4MB.
165    pub fn set_metadata_blob(mut self, input: ::std::option::Option<::aws_smithy_types::byte_stream::ByteStream>) -> Self {
166        self.metadata_blob = input;
167        self
168    }
169    /// Optional metadata associated with an Object. Maximum length is 4MB.
170    pub fn get_metadata_blob(&self) -> &::std::option::Option<::aws_smithy_types::byte_stream::ByteStream> {
171        &self.metadata_blob
172    }
173    /// The size of MetadataBlob.
174    pub fn metadata_blob_length(mut self, input: i64) -> Self {
175        self.metadata_blob_length = ::std::option::Option::Some(input);
176        self
177    }
178    /// The size of MetadataBlob.
179    pub fn set_metadata_blob_length(mut self, input: ::std::option::Option<i64>) -> Self {
180        self.metadata_blob_length = input;
181        self
182    }
183    /// The size of MetadataBlob.
184    pub fn get_metadata_blob_length(&self) -> &::std::option::Option<i64> {
185        &self.metadata_blob_length
186    }
187    /// Checksum of MetadataBlob.
188    pub fn metadata_blob_checksum(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
189        self.metadata_blob_checksum = ::std::option::Option::Some(input.into());
190        self
191    }
192    /// Checksum of MetadataBlob.
193    pub fn set_metadata_blob_checksum(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
194        self.metadata_blob_checksum = input;
195        self
196    }
197    /// Checksum of MetadataBlob.
198    pub fn get_metadata_blob_checksum(&self) -> &::std::option::Option<::std::string::String> {
199        &self.metadata_blob_checksum
200    }
201    /// Checksum algorithm.
202    pub fn metadata_blob_checksum_algorithm(mut self, input: crate::types::DataChecksumAlgorithm) -> Self {
203        self.metadata_blob_checksum_algorithm = ::std::option::Option::Some(input);
204        self
205    }
206    /// Checksum algorithm.
207    pub fn set_metadata_blob_checksum_algorithm(mut self, input: ::std::option::Option<crate::types::DataChecksumAlgorithm>) -> Self {
208        self.metadata_blob_checksum_algorithm = input;
209        self
210    }
211    /// Checksum algorithm.
212    pub fn get_metadata_blob_checksum_algorithm(&self) -> &::std::option::Option<crate::types::DataChecksumAlgorithm> {
213        &self.metadata_blob_checksum_algorithm
214    }
215    /// Consumes the builder and constructs a [`NotifyObjectCompleteInput`](crate::operation::notify_object_complete::NotifyObjectCompleteInput).
216    pub fn build(
217        self,
218    ) -> ::std::result::Result<crate::operation::notify_object_complete::NotifyObjectCompleteInput, ::aws_smithy_types::error::operation::BuildError>
219    {
220        ::std::result::Result::Ok(crate::operation::notify_object_complete::NotifyObjectCompleteInput {
221            backup_job_id: self.backup_job_id,
222            upload_id: self.upload_id,
223            object_checksum: self.object_checksum,
224            object_checksum_algorithm: self.object_checksum_algorithm,
225            metadata_string: self.metadata_string,
226            metadata_blob: self.metadata_blob.unwrap_or_default(),
227            metadata_blob_length: self.metadata_blob_length,
228            metadata_blob_checksum: self.metadata_blob_checksum,
229            metadata_blob_checksum_algorithm: self.metadata_blob_checksum_algorithm,
230        })
231    }
232}