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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_featured_results_set::_update_featured_results_set_input::UpdateFeaturedResultsSetInputBuilder;
pub use crate::operation::update_featured_results_set::_update_featured_results_set_output::UpdateFeaturedResultsSetOutputBuilder;
impl crate::operation::update_featured_results_set::builders::UpdateFeaturedResultsSetInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::update_featured_results_set::UpdateFeaturedResultsSetOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::update_featured_results_set::UpdateFeaturedResultsSetError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.update_featured_results_set();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `UpdateFeaturedResultsSet`.
///
/// <p>Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct UpdateFeaturedResultsSetFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::update_featured_results_set::builders::UpdateFeaturedResultsSetInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::update_featured_results_set::UpdateFeaturedResultsSetOutput,
crate::operation::update_featured_results_set::UpdateFeaturedResultsSetError,
> for UpdateFeaturedResultsSetFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::update_featured_results_set::UpdateFeaturedResultsSetOutput,
crate::operation::update_featured_results_set::UpdateFeaturedResultsSetError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl UpdateFeaturedResultsSetFluentBuilder {
/// Creates a new `UpdateFeaturedResultsSetFluentBuilder`.
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 UpdateFeaturedResultsSet as a reference.
pub fn as_input(&self) -> &crate::operation::update_featured_results_set::builders::UpdateFeaturedResultsSetInputBuilder {
&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::update_featured_results_set::UpdateFeaturedResultsSetOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::update_featured_results_set::UpdateFeaturedResultsSetError,
::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::update_featured_results_set::UpdateFeaturedResultsSet::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::update_featured_results_set::UpdateFeaturedResultsSet::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::update_featured_results_set::UpdateFeaturedResultsSetOutput,
crate::operation::update_featured_results_set::UpdateFeaturedResultsSetError,
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 used for featuring results.</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 used for featuring results.</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 used for featuring results.</p>
pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_index_id()
}
/// <p>The identifier of the set of featured results that you want to update.</p>
pub fn featured_results_set_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.featured_results_set_id(input.into());
self
}
/// <p>The identifier of the set of featured results that you want to update.</p>
pub fn set_featured_results_set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_featured_results_set_id(input);
self
}
/// <p>The identifier of the set of featured results that you want to update.</p>
pub fn get_featured_results_set_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_featured_results_set_id()
}
/// <p>A new name for the set of featured results.</p>
pub fn featured_results_set_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.featured_results_set_name(input.into());
self
}
/// <p>A new name for the set of featured results.</p>
pub fn set_featured_results_set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_featured_results_set_name(input);
self
}
/// <p>A new name for the set of featured results.</p>
pub fn get_featured_results_set_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_featured_results_set_name()
}
/// <p>A new description for the set of featured results.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A new description for the set of featured results.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>A new description for the set of featured results.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_description()
}
/// <p>You can set the status to <code>ACTIVE</code> or <code>INACTIVE</code>. When the value is <code>ACTIVE</code>, featured results are ready for use. You can still configure your settings before setting the status to <code>ACTIVE</code>. The queries you specify for featured results must be unique per featured results set for each index, whether the status is <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
pub fn status(mut self, input: crate::types::FeaturedResultsSetStatus) -> Self {
self.inner = self.inner.status(input);
self
}
/// <p>You can set the status to <code>ACTIVE</code> or <code>INACTIVE</code>. When the value is <code>ACTIVE</code>, featured results are ready for use. You can still configure your settings before setting the status to <code>ACTIVE</code>. The queries you specify for featured results must be unique per featured results set for each index, whether the status is <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::FeaturedResultsSetStatus>) -> Self {
self.inner = self.inner.set_status(input);
self
}
/// <p>You can set the status to <code>ACTIVE</code> or <code>INACTIVE</code>. When the value is <code>ACTIVE</code>, featured results are ready for use. You can still configure your settings before setting the status to <code>ACTIVE</code>. The queries you specify for featured results must be unique per featured results set for each index, whether the status is <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
pub fn get_status(&self) -> &::std::option::Option<crate::types::FeaturedResultsSetStatus> {
self.inner.get_status()
}
///
/// Appends an item to `QueryTexts`.
///
/// To override the contents of this collection use [`set_query_texts`](Self::set_query_texts).
///
/// <p>A list of queries for featuring results. For more information on the list of queries, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
pub fn query_texts(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.query_texts(input.into());
self
}
/// <p>A list of queries for featuring results. For more information on the list of queries, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
pub fn set_query_texts(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_query_texts(input);
self
}
/// <p>A list of queries for featuring results. For more information on the list of queries, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
pub fn get_query_texts(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_query_texts()
}
///
/// Appends an item to `FeaturedDocuments`.
///
/// To override the contents of this collection use [`set_featured_documents`](Self::set_featured_documents).
///
/// <p>A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
pub fn featured_documents(mut self, input: crate::types::FeaturedDocument) -> Self {
self.inner = self.inner.featured_documents(input);
self
}
/// <p>A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
pub fn set_featured_documents(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::FeaturedDocument>>) -> Self {
self.inner = self.inner.set_featured_documents(input);
self
}
/// <p>A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
pub fn get_featured_documents(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::FeaturedDocument>> {
self.inner.get_featured_documents()
}
}