aws-sdk-quicksight 1.145.0

AWS SDK for Amazon QuickSight
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

// 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 SearchKnowledgeBasesInput {
    /// <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
    pub aws_account_id: ::std::option::Option<::std::string::String>,
    /// <p>The token for the next set of results, or null if there are no more results.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>The maximum number of results to return.</p>
    pub max_results: ::std::option::Option<i32>,
    /// <p>The filters to apply when searching knowledge bases.</p>
    pub filters: ::std::option::Option<::std::vec::Vec<crate::types::KnowledgeBaseSearchFilter>>,
    /// <p>The sort configuration for the search results.</p>
    pub sort_by: ::std::option::Option<crate::types::KnowledgeBaseSortBy>,
}
impl SearchKnowledgeBasesInput {
    /// <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
    pub fn aws_account_id(&self) -> ::std::option::Option<&str> {
        self.aws_account_id.as_deref()
    }
    /// <p>The token for the next set of results, or null if there are no more results.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>The maximum number of results to return.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
    /// <p>The filters to apply when searching knowledge bases.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.filters.is_none()`.
    pub fn filters(&self) -> &[crate::types::KnowledgeBaseSearchFilter] {
        self.filters.as_deref().unwrap_or_default()
    }
    /// <p>The sort configuration for the search results.</p>
    pub fn sort_by(&self) -> ::std::option::Option<&crate::types::KnowledgeBaseSortBy> {
        self.sort_by.as_ref()
    }
}
impl SearchKnowledgeBasesInput {
    /// Creates a new builder-style object to manufacture [`SearchKnowledgeBasesInput`](crate::operation::search_knowledge_bases::SearchKnowledgeBasesInput).
    pub fn builder() -> crate::operation::search_knowledge_bases::builders::SearchKnowledgeBasesInputBuilder {
        crate::operation::search_knowledge_bases::builders::SearchKnowledgeBasesInputBuilder::default()
    }
}

/// A builder for [`SearchKnowledgeBasesInput`](crate::operation::search_knowledge_bases::SearchKnowledgeBasesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SearchKnowledgeBasesInputBuilder {
    pub(crate) aws_account_id: ::std::option::Option<::std::string::String>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) max_results: ::std::option::Option<i32>,
    pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::KnowledgeBaseSearchFilter>>,
    pub(crate) sort_by: ::std::option::Option<crate::types::KnowledgeBaseSortBy>,
}
impl SearchKnowledgeBasesInputBuilder {
    /// <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
    /// This field is required.
    pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.aws_account_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
    pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.aws_account_id = input;
        self
    }
    /// <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
    pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.aws_account_id
    }
    /// <p>The token for the next set of results, or null if there are no more 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>The token for the next set of results, or null if there are no more results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>The token for the next set of results, or null if there are no more results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// <p>The maximum number of results to return.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.max_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum number of results to return.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.max_results = input;
        self
    }
    /// <p>The maximum number of results to return.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// Appends an item to `filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>The filters to apply when searching knowledge bases.</p>
    pub fn filters(mut self, input: crate::types::KnowledgeBaseSearchFilter) -> Self {
        let mut v = self.filters.unwrap_or_default();
        v.push(input);
        self.filters = ::std::option::Option::Some(v);
        self
    }
    /// <p>The filters to apply when searching knowledge bases.</p>
    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::KnowledgeBaseSearchFilter>>) -> Self {
        self.filters = input;
        self
    }
    /// <p>The filters to apply when searching knowledge bases.</p>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::KnowledgeBaseSearchFilter>> {
        &self.filters
    }
    /// <p>The sort configuration for the search results.</p>
    pub fn sort_by(mut self, input: crate::types::KnowledgeBaseSortBy) -> Self {
        self.sort_by = ::std::option::Option::Some(input);
        self
    }
    /// <p>The sort configuration for the search results.</p>
    pub fn set_sort_by(mut self, input: ::std::option::Option<crate::types::KnowledgeBaseSortBy>) -> Self {
        self.sort_by = input;
        self
    }
    /// <p>The sort configuration for the search results.</p>
    pub fn get_sort_by(&self) -> &::std::option::Option<crate::types::KnowledgeBaseSortBy> {
        &self.sort_by
    }
    /// Consumes the builder and constructs a [`SearchKnowledgeBasesInput`](crate::operation::search_knowledge_bases::SearchKnowledgeBasesInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::search_knowledge_bases::SearchKnowledgeBasesInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::search_knowledge_bases::SearchKnowledgeBasesInput {
            aws_account_id: self.aws_account_id,
            next_token: self.next_token,
            max_results: self.max_results,
            filters: self.filters,
            sort_by: self.sort_by,
        })
    }
}