aws_sdk_quicksight/operation/describe_dashboard/
_describe_dashboard_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::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct DescribeDashboardInput {
6    /// <p>The ID of the Amazon Web Services account that contains the dashboard that you're describing.</p>
7    pub aws_account_id: ::std::option::Option<::std::string::String>,
8    /// <p>The ID for the dashboard.</p>
9    pub dashboard_id: ::std::option::Option<::std::string::String>,
10    /// <p>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.</p>
11    pub version_number: ::std::option::Option<i64>,
12    /// <p>The alias name.</p>
13    pub alias_name: ::std::option::Option<::std::string::String>,
14}
15impl DescribeDashboardInput {
16    /// <p>The ID of the Amazon Web Services account that contains the dashboard that you're describing.</p>
17    pub fn aws_account_id(&self) -> ::std::option::Option<&str> {
18        self.aws_account_id.as_deref()
19    }
20    /// <p>The ID for the dashboard.</p>
21    pub fn dashboard_id(&self) -> ::std::option::Option<&str> {
22        self.dashboard_id.as_deref()
23    }
24    /// <p>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.</p>
25    pub fn version_number(&self) -> ::std::option::Option<i64> {
26        self.version_number
27    }
28    /// <p>The alias name.</p>
29    pub fn alias_name(&self) -> ::std::option::Option<&str> {
30        self.alias_name.as_deref()
31    }
32}
33impl DescribeDashboardInput {
34    /// Creates a new builder-style object to manufacture [`DescribeDashboardInput`](crate::operation::describe_dashboard::DescribeDashboardInput).
35    pub fn builder() -> crate::operation::describe_dashboard::builders::DescribeDashboardInputBuilder {
36        crate::operation::describe_dashboard::builders::DescribeDashboardInputBuilder::default()
37    }
38}
39
40/// A builder for [`DescribeDashboardInput`](crate::operation::describe_dashboard::DescribeDashboardInput).
41#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
42#[non_exhaustive]
43pub struct DescribeDashboardInputBuilder {
44    pub(crate) aws_account_id: ::std::option::Option<::std::string::String>,
45    pub(crate) dashboard_id: ::std::option::Option<::std::string::String>,
46    pub(crate) version_number: ::std::option::Option<i64>,
47    pub(crate) alias_name: ::std::option::Option<::std::string::String>,
48}
49impl DescribeDashboardInputBuilder {
50    /// <p>The ID of the Amazon Web Services account that contains the dashboard that you're describing.</p>
51    /// This field is required.
52    pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
53        self.aws_account_id = ::std::option::Option::Some(input.into());
54        self
55    }
56    /// <p>The ID of the Amazon Web Services account that contains the dashboard that you're describing.</p>
57    pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
58        self.aws_account_id = input;
59        self
60    }
61    /// <p>The ID of the Amazon Web Services account that contains the dashboard that you're describing.</p>
62    pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
63        &self.aws_account_id
64    }
65    /// <p>The ID for the dashboard.</p>
66    /// This field is required.
67    pub fn dashboard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
68        self.dashboard_id = ::std::option::Option::Some(input.into());
69        self
70    }
71    /// <p>The ID for the dashboard.</p>
72    pub fn set_dashboard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
73        self.dashboard_id = input;
74        self
75    }
76    /// <p>The ID for the dashboard.</p>
77    pub fn get_dashboard_id(&self) -> &::std::option::Option<::std::string::String> {
78        &self.dashboard_id
79    }
80    /// <p>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.</p>
81    pub fn version_number(mut self, input: i64) -> Self {
82        self.version_number = ::std::option::Option::Some(input);
83        self
84    }
85    /// <p>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.</p>
86    pub fn set_version_number(mut self, input: ::std::option::Option<i64>) -> Self {
87        self.version_number = input;
88        self
89    }
90    /// <p>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.</p>
91    pub fn get_version_number(&self) -> &::std::option::Option<i64> {
92        &self.version_number
93    }
94    /// <p>The alias name.</p>
95    pub fn alias_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
96        self.alias_name = ::std::option::Option::Some(input.into());
97        self
98    }
99    /// <p>The alias name.</p>
100    pub fn set_alias_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
101        self.alias_name = input;
102        self
103    }
104    /// <p>The alias name.</p>
105    pub fn get_alias_name(&self) -> &::std::option::Option<::std::string::String> {
106        &self.alias_name
107    }
108    /// Consumes the builder and constructs a [`DescribeDashboardInput`](crate::operation::describe_dashboard::DescribeDashboardInput).
109    pub fn build(
110        self,
111    ) -> ::std::result::Result<crate::operation::describe_dashboard::DescribeDashboardInput, ::aws_smithy_types::error::operation::BuildError> {
112        ::std::result::Result::Ok(crate::operation::describe_dashboard::DescribeDashboardInput {
113            aws_account_id: self.aws_account_id,
114            dashboard_id: self.dashboard_id,
115            version_number: self.version_number,
116            alias_name: self.alias_name,
117        })
118    }
119}