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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_query_suggestions::_get_query_suggestions_input::GetQuerySuggestionsInputBuilder;
pub use crate::operation::get_query_suggestions::_get_query_suggestions_output::GetQuerySuggestionsOutputBuilder;
impl crate::operation::get_query_suggestions::builders::GetQuerySuggestionsInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::get_query_suggestions::GetQuerySuggestionsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_query_suggestions::GetQuerySuggestionsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.get_query_suggestions();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `GetQuerySuggestions`.
///
/// <p>Fetches the queries that are suggested to your users.</p>
/// <p><code>GetQuerySuggestions</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetQuerySuggestionsFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::get_query_suggestions::builders::GetQuerySuggestionsInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::get_query_suggestions::GetQuerySuggestionsOutput,
crate::operation::get_query_suggestions::GetQuerySuggestionsError,
> for GetQuerySuggestionsFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::get_query_suggestions::GetQuerySuggestionsOutput,
crate::operation::get_query_suggestions::GetQuerySuggestionsError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl GetQuerySuggestionsFluentBuilder {
/// Creates a new `GetQuerySuggestionsFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the GetQuerySuggestions as a reference.
pub fn as_input(&self) -> &crate::operation::get_query_suggestions::builders::GetQuerySuggestionsInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::get_query_suggestions::GetQuerySuggestionsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_query_suggestions::GetQuerySuggestionsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::get_query_suggestions::GetQuerySuggestions::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::get_query_suggestions::GetQuerySuggestions::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::get_query_suggestions::GetQuerySuggestionsOutput,
crate::operation::get_query_suggestions::GetQuerySuggestionsError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The identifier of the index you want to get query suggestions from.</p>
pub fn index_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.index_id(input.into());
self
}
/// <p>The identifier of the index you want to get query suggestions from.</p>
pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_index_id(input);
self
}
/// <p>The identifier of the index you want to get query suggestions from.</p>
pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_index_id()
}
/// <p>The text of a user's query to generate query suggestions.</p>
/// <p>A query is suggested if the query prefix matches what a user starts to type as their query.</p>
/// <p>Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.</p>
pub fn query_text(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.query_text(input.into());
self
}
/// <p>The text of a user's query to generate query suggestions.</p>
/// <p>A query is suggested if the query prefix matches what a user starts to type as their query.</p>
/// <p>Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.</p>
pub fn set_query_text(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_query_text(input);
self
}
/// <p>The text of a user's query to generate query suggestions.</p>
/// <p>A query is suggested if the query prefix matches what a user starts to type as their query.</p>
/// <p>Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.</p>
pub fn get_query_text(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_query_text()
}
/// <p>The maximum number of query suggestions you want to show to your users.</p>
pub fn max_suggestions_count(mut self, input: i32) -> Self {
self.inner = self.inner.max_suggestions_count(input);
self
}
/// <p>The maximum number of query suggestions you want to show to your users.</p>
pub fn set_max_suggestions_count(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_suggestions_count(input);
self
}
/// <p>The maximum number of query suggestions you want to show to your users.</p>
pub fn get_max_suggestions_count(&self) -> &::std::option::Option<i32> {
self.inner.get_max_suggestions_count()
}
///
/// Appends an item to `SuggestionTypes`.
///
/// To override the contents of this collection use [`set_suggestion_types`](Self::set_suggestion_types).
///
/// <p>The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.</p>
/// <p>If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.</p>
/// <p>If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.</p>
pub fn suggestion_types(mut self, input: crate::types::SuggestionType) -> Self {
self.inner = self.inner.suggestion_types(input);
self
}
/// <p>The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.</p>
/// <p>If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.</p>
/// <p>If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.</p>
pub fn set_suggestion_types(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SuggestionType>>) -> Self {
self.inner = self.inner.set_suggestion_types(input);
self
}
/// <p>The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.</p>
/// <p>If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.</p>
/// <p>If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.</p>
pub fn get_suggestion_types(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SuggestionType>> {
self.inner.get_suggestion_types()
}
/// <p>Configuration information for the document fields/attributes that you want to base query suggestions on.</p>
pub fn attribute_suggestions_config(mut self, input: crate::types::AttributeSuggestionsGetConfig) -> Self {
self.inner = self.inner.attribute_suggestions_config(input);
self
}
/// <p>Configuration information for the document fields/attributes that you want to base query suggestions on.</p>
pub fn set_attribute_suggestions_config(mut self, input: ::std::option::Option<crate::types::AttributeSuggestionsGetConfig>) -> Self {
self.inner = self.inner.set_attribute_suggestions_config(input);
self
}
/// <p>Configuration information for the document fields/attributes that you want to base query suggestions on.</p>
pub fn get_attribute_suggestions_config(&self) -> &::std::option::Option<crate::types::AttributeSuggestionsGetConfig> {
self.inner.get_attribute_suggestions_config()
}
}