aws_sdk_s3control/operation/list_regional_buckets/
_list_regional_buckets_output.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::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct ListRegionalBucketsOutput {
6    /// <p></p>
7    pub regional_bucket_list: ::std::option::Option<::std::vec::Vec<crate::types::RegionalBucket>>,
8    /// <p><code>NextToken</code> is sent when <code>isTruncated</code> is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this <code>NextToken</code>. <code>NextToken</code> is obfuscated and is not a real key.</p>
9    pub next_token: ::std::option::Option<::std::string::String>,
10    _request_id: Option<String>,
11}
12impl ListRegionalBucketsOutput {
13    /// <p></p>
14    ///
15    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.regional_bucket_list.is_none()`.
16    pub fn regional_bucket_list(&self) -> &[crate::types::RegionalBucket] {
17        self.regional_bucket_list.as_deref().unwrap_or_default()
18    }
19    /// <p><code>NextToken</code> is sent when <code>isTruncated</code> is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this <code>NextToken</code>. <code>NextToken</code> is obfuscated and is not a real key.</p>
20    pub fn next_token(&self) -> ::std::option::Option<&str> {
21        self.next_token.as_deref()
22    }
23}
24impl ::aws_types::request_id::RequestId for ListRegionalBucketsOutput {
25    fn request_id(&self) -> Option<&str> {
26        self._request_id.as_deref()
27    }
28}
29impl ListRegionalBucketsOutput {
30    /// Creates a new builder-style object to manufacture [`ListRegionalBucketsOutput`](crate::operation::list_regional_buckets::ListRegionalBucketsOutput).
31    pub fn builder() -> crate::operation::list_regional_buckets::builders::ListRegionalBucketsOutputBuilder {
32        crate::operation::list_regional_buckets::builders::ListRegionalBucketsOutputBuilder::default()
33    }
34}
35
36/// A builder for [`ListRegionalBucketsOutput`](crate::operation::list_regional_buckets::ListRegionalBucketsOutput).
37#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
38#[non_exhaustive]
39pub struct ListRegionalBucketsOutputBuilder {
40    pub(crate) regional_bucket_list: ::std::option::Option<::std::vec::Vec<crate::types::RegionalBucket>>,
41    pub(crate) next_token: ::std::option::Option<::std::string::String>,
42    _request_id: Option<String>,
43}
44impl ListRegionalBucketsOutputBuilder {
45    /// Appends an item to `regional_bucket_list`.
46    ///
47    /// To override the contents of this collection use [`set_regional_bucket_list`](Self::set_regional_bucket_list).
48    ///
49    /// <p></p>
50    pub fn regional_bucket_list(mut self, input: crate::types::RegionalBucket) -> Self {
51        let mut v = self.regional_bucket_list.unwrap_or_default();
52        v.push(input);
53        self.regional_bucket_list = ::std::option::Option::Some(v);
54        self
55    }
56    /// <p></p>
57    pub fn set_regional_bucket_list(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RegionalBucket>>) -> Self {
58        self.regional_bucket_list = input;
59        self
60    }
61    /// <p></p>
62    pub fn get_regional_bucket_list(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RegionalBucket>> {
63        &self.regional_bucket_list
64    }
65    /// <p><code>NextToken</code> is sent when <code>isTruncated</code> is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this <code>NextToken</code>. <code>NextToken</code> is obfuscated and is not a real key.</p>
66    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
67        self.next_token = ::std::option::Option::Some(input.into());
68        self
69    }
70    /// <p><code>NextToken</code> is sent when <code>isTruncated</code> is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this <code>NextToken</code>. <code>NextToken</code> is obfuscated and is not a real key.</p>
71    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
72        self.next_token = input;
73        self
74    }
75    /// <p><code>NextToken</code> is sent when <code>isTruncated</code> is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this <code>NextToken</code>. <code>NextToken</code> is obfuscated and is not a real key.</p>
76    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
77        &self.next_token
78    }
79    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
80        self._request_id = Some(request_id.into());
81        self
82    }
83
84    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
85        self._request_id = request_id;
86        self
87    }
88    /// Consumes the builder and constructs a [`ListRegionalBucketsOutput`](crate::operation::list_regional_buckets::ListRegionalBucketsOutput).
89    pub fn build(self) -> crate::operation::list_regional_buckets::ListRegionalBucketsOutput {
90        crate::operation::list_regional_buckets::ListRegionalBucketsOutput {
91            regional_bucket_list: self.regional_bucket_list,
92            next_token: self.next_token,
93            _request_id: self._request_id,
94        }
95    }
96}