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
// 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 RetrieveOutput {
/// <p>The identifier of query used for the search. You also use <code>QueryId</code> to identify the search when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">Submitfeedback</a> API.</p>
pub query_id: ::std::option::Option<::std::string::String>,
/// <p>The results of the retrieved relevant passages for the search.</p>
pub result_items: ::std::option::Option<::std::vec::Vec<crate::types::RetrieveResultItem>>,
_request_id: Option<String>,
}
impl RetrieveOutput {
/// <p>The identifier of query used for the search. You also use <code>QueryId</code> to identify the search when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">Submitfeedback</a> API.</p>
pub fn query_id(&self) -> ::std::option::Option<&str> {
self.query_id.as_deref()
}
/// <p>The results of the retrieved relevant passages for the search.</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 `.result_items.is_none()`.
pub fn result_items(&self) -> &[crate::types::RetrieveResultItem] {
self.result_items.as_deref().unwrap_or_default()
}
}
impl ::aws_types::request_id::RequestId for RetrieveOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl RetrieveOutput {
/// Creates a new builder-style object to manufacture [`RetrieveOutput`](crate::operation::retrieve::RetrieveOutput).
pub fn builder() -> crate::operation::retrieve::builders::RetrieveOutputBuilder {
crate::operation::retrieve::builders::RetrieveOutputBuilder::default()
}
}
/// A builder for [`RetrieveOutput`](crate::operation::retrieve::RetrieveOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct RetrieveOutputBuilder {
pub(crate) query_id: ::std::option::Option<::std::string::String>,
pub(crate) result_items: ::std::option::Option<::std::vec::Vec<crate::types::RetrieveResultItem>>,
_request_id: Option<String>,
}
impl RetrieveOutputBuilder {
/// <p>The identifier of query used for the search. You also use <code>QueryId</code> to identify the search when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">Submitfeedback</a> API.</p>
pub fn query_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.query_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of query used for the search. You also use <code>QueryId</code> to identify the search when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">Submitfeedback</a> API.</p>
pub fn set_query_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.query_id = input;
self
}
/// <p>The identifier of query used for the search. You also use <code>QueryId</code> to identify the search when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">Submitfeedback</a> API.</p>
pub fn get_query_id(&self) -> &::std::option::Option<::std::string::String> {
&self.query_id
}
/// Appends an item to `result_items`.
///
/// To override the contents of this collection use [`set_result_items`](Self::set_result_items).
///
/// <p>The results of the retrieved relevant passages for the search.</p>
pub fn result_items(mut self, input: crate::types::RetrieveResultItem) -> Self {
let mut v = self.result_items.unwrap_or_default();
v.push(input);
self.result_items = ::std::option::Option::Some(v);
self
}
/// <p>The results of the retrieved relevant passages for the search.</p>
pub fn set_result_items(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RetrieveResultItem>>) -> Self {
self.result_items = input;
self
}
/// <p>The results of the retrieved relevant passages for the search.</p>
pub fn get_result_items(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RetrieveResultItem>> {
&self.result_items
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`RetrieveOutput`](crate::operation::retrieve::RetrieveOutput).
pub fn build(self) -> crate::operation::retrieve::RetrieveOutput {
crate::operation::retrieve::RetrieveOutput {
query_id: self.query_id,
result_items: self.result_items,
_request_id: self._request_id,
}
}
}