aws_sdk_fsx/operation/describe_volumes/
_describe_volumes_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 DescribeVolumesOutput {
6    /// <p>Returned after a successful <code>DescribeVolumes</code> operation, describing each volume.</p>
7    pub volumes: ::std::option::Option<::std::vec::Vec<crate::types::Volume>>,
8    /// <p>(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous <code>NextToken</code> value left off.</p>
9    pub next_token: ::std::option::Option<::std::string::String>,
10    _request_id: Option<String>,
11}
12impl DescribeVolumesOutput {
13    /// <p>Returned after a successful <code>DescribeVolumes</code> operation, describing each volume.</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 `.volumes.is_none()`.
16    pub fn volumes(&self) -> &[crate::types::Volume] {
17        self.volumes.as_deref().unwrap_or_default()
18    }
19    /// <p>(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous <code>NextToken</code> value left off.</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 DescribeVolumesOutput {
25    fn request_id(&self) -> Option<&str> {
26        self._request_id.as_deref()
27    }
28}
29impl DescribeVolumesOutput {
30    /// Creates a new builder-style object to manufacture [`DescribeVolumesOutput`](crate::operation::describe_volumes::DescribeVolumesOutput).
31    pub fn builder() -> crate::operation::describe_volumes::builders::DescribeVolumesOutputBuilder {
32        crate::operation::describe_volumes::builders::DescribeVolumesOutputBuilder::default()
33    }
34}
35
36/// A builder for [`DescribeVolumesOutput`](crate::operation::describe_volumes::DescribeVolumesOutput).
37#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
38#[non_exhaustive]
39pub struct DescribeVolumesOutputBuilder {
40    pub(crate) volumes: ::std::option::Option<::std::vec::Vec<crate::types::Volume>>,
41    pub(crate) next_token: ::std::option::Option<::std::string::String>,
42    _request_id: Option<String>,
43}
44impl DescribeVolumesOutputBuilder {
45    /// Appends an item to `volumes`.
46    ///
47    /// To override the contents of this collection use [`set_volumes`](Self::set_volumes).
48    ///
49    /// <p>Returned after a successful <code>DescribeVolumes</code> operation, describing each volume.</p>
50    pub fn volumes(mut self, input: crate::types::Volume) -> Self {
51        let mut v = self.volumes.unwrap_or_default();
52        v.push(input);
53        self.volumes = ::std::option::Option::Some(v);
54        self
55    }
56    /// <p>Returned after a successful <code>DescribeVolumes</code> operation, describing each volume.</p>
57    pub fn set_volumes(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Volume>>) -> Self {
58        self.volumes = input;
59        self
60    }
61    /// <p>Returned after a successful <code>DescribeVolumes</code> operation, describing each volume.</p>
62    pub fn get_volumes(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Volume>> {
63        &self.volumes
64    }
65    /// <p>(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous <code>NextToken</code> value left off.</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>(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous <code>NextToken</code> value left off.</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>(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous <code>NextToken</code> value left off.</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 [`DescribeVolumesOutput`](crate::operation::describe_volumes::DescribeVolumesOutput).
89    pub fn build(self) -> crate::operation::describe_volumes::DescribeVolumesOutput {
90        crate::operation::describe_volumes::DescribeVolumesOutput {
91            volumes: self.volumes,
92            next_token: self.next_token,
93            _request_id: self._request_id,
94        }
95    }
96}