aws-sdk-cloudtrail 1.104.0

AWS SDK for AWS CloudTrail
Documentation 
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ListDashboardsInput {
    /// <p>Specify a name prefix to filter on.</p>
    pub name_prefix: ::std::option::Option<::std::string::String>,
    /// <p>Specify a dashboard type to filter on: <code>CUSTOM</code> or <code>MANAGED</code>.</p>
    pub r#type: ::std::option::Option<crate::types::DashboardType>,
    /// <p>A token you can use to get the next page of dashboard results.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>The maximum number of dashboards to display on a single page.</p>
    pub max_results: ::std::option::Option<i32>,
}
impl ListDashboardsInput {
    /// <p>Specify a name prefix to filter on.</p>
    pub fn name_prefix(&self) -> ::std::option::Option<&str> {
        self.name_prefix.as_deref()
    }
    /// <p>Specify a dashboard type to filter on: <code>CUSTOM</code> or <code>MANAGED</code>.</p>
    pub fn r#type(&self) -> ::std::option::Option<&crate::types::DashboardType> {
        self.r#type.as_ref()
    }
    /// <p>A token you can use to get the next page of dashboard results.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>The maximum number of dashboards to display on a single page.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
}
impl ListDashboardsInput {
    /// Creates a new builder-style object to manufacture [`ListDashboardsInput`](crate::operation::list_dashboards::ListDashboardsInput).
    pub fn builder() -> crate::operation::list_dashboards::builders::ListDashboardsInputBuilder {
        crate::operation::list_dashboards::builders::ListDashboardsInputBuilder::default()
    }
}

/// A builder for [`ListDashboardsInput`](crate::operation::list_dashboards::ListDashboardsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListDashboardsInputBuilder {
    pub(crate) name_prefix: ::std::option::Option<::std::string::String>,
    pub(crate) r#type: ::std::option::Option<crate::types::DashboardType>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) max_results: ::std::option::Option<i32>,
}
impl ListDashboardsInputBuilder {
    /// <p>Specify a name prefix to filter on.</p>
    pub fn name_prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name_prefix = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Specify a name prefix to filter on.</p>
    pub fn set_name_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name_prefix = input;
        self
    }
    /// <p>Specify a name prefix to filter on.</p>
    pub fn get_name_prefix(&self) -> &::std::option::Option<::std::string::String> {
        &self.name_prefix
    }
    /// <p>Specify a dashboard type to filter on: <code>CUSTOM</code> or <code>MANAGED</code>.</p>
    pub fn r#type(mut self, input: crate::types::DashboardType) -> Self {
        self.r#type = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specify a dashboard type to filter on: <code>CUSTOM</code> or <code>MANAGED</code>.</p>
    pub fn set_type(mut self, input: ::std::option::Option<crate::types::DashboardType>) -> Self {
        self.r#type = input;
        self
    }
    /// <p>Specify a dashboard type to filter on: <code>CUSTOM</code> or <code>MANAGED</code>.</p>
    pub fn get_type(&self) -> &::std::option::Option<crate::types::DashboardType> {
        &self.r#type
    }
    /// <p>A token you can use to get the next page of dashboard results.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.next_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A token you can use to get the next page of dashboard results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>A token you can use to get the next page of dashboard results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// <p>The maximum number of dashboards to display on a single page.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.max_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum number of dashboards to display on a single page.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.max_results = input;
        self
    }
    /// <p>The maximum number of dashboards to display on a single page.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// Consumes the builder and constructs a [`ListDashboardsInput`](crate::operation::list_dashboards::ListDashboardsInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::list_dashboards::ListDashboardsInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::list_dashboards::ListDashboardsInput {
            name_prefix: self.name_prefix,
            r#type: self.r#type,
            next_token: self.next_token,
            max_results: self.max_results,
        })
    }
}