aws_sdk_bedrockagentruntime/operation/retrieve/
_retrieve_output.rs

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
// 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)]
pub struct RetrieveOutput {
    /// <p>A list of results from querying the knowledge base.</p>
    pub retrieval_results: ::std::vec::Vec<crate::types::KnowledgeBaseRetrievalResult>,
    /// <p>Specifies if there is a guardrail intervention in the response.</p>
    pub guardrail_action: ::std::option::Option<crate::types::GuadrailAction>,
    /// <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl RetrieveOutput {
    /// <p>A list of results from querying the knowledge base.</p>
    pub fn retrieval_results(&self) -> &[crate::types::KnowledgeBaseRetrievalResult] {
        use std::ops::Deref;
        self.retrieval_results.deref()
    }
    /// <p>Specifies if there is a guardrail intervention in the response.</p>
    pub fn guardrail_action(&self) -> ::std::option::Option<&crate::types::GuadrailAction> {
        self.guardrail_action.as_ref()
    }
    /// <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
}
impl ::std::fmt::Debug for RetrieveOutput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("RetrieveOutput");
        formatter.field("retrieval_results", &"*** Sensitive Data Redacted ***");
        formatter.field("guardrail_action", &self.guardrail_action);
        formatter.field("next_token", &self.next_token);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}
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)]
#[non_exhaustive]
pub struct RetrieveOutputBuilder {
    pub(crate) retrieval_results: ::std::option::Option<::std::vec::Vec<crate::types::KnowledgeBaseRetrievalResult>>,
    pub(crate) guardrail_action: ::std::option::Option<crate::types::GuadrailAction>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl RetrieveOutputBuilder {
    /// Appends an item to `retrieval_results`.
    ///
    /// To override the contents of this collection use [`set_retrieval_results`](Self::set_retrieval_results).
    ///
    /// <p>A list of results from querying the knowledge base.</p>
    pub fn retrieval_results(mut self, input: crate::types::KnowledgeBaseRetrievalResult) -> Self {
        let mut v = self.retrieval_results.unwrap_or_default();
        v.push(input);
        self.retrieval_results = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of results from querying the knowledge base.</p>
    pub fn set_retrieval_results(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::KnowledgeBaseRetrievalResult>>) -> Self {
        self.retrieval_results = input;
        self
    }
    /// <p>A list of results from querying the knowledge base.</p>
    pub fn get_retrieval_results(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::KnowledgeBaseRetrievalResult>> {
        &self.retrieval_results
    }
    /// <p>Specifies if there is a guardrail intervention in the response.</p>
    pub fn guardrail_action(mut self, input: crate::types::GuadrailAction) -> Self {
        self.guardrail_action = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies if there is a guardrail intervention in the response.</p>
    pub fn set_guardrail_action(mut self, input: ::std::option::Option<crate::types::GuadrailAction>) -> Self {
        self.guardrail_action = input;
        self
    }
    /// <p>Specifies if there is a guardrail intervention in the response.</p>
    pub fn get_guardrail_action(&self) -> &::std::option::Option<crate::types::GuadrailAction> {
        &self.guardrail_action
    }
    /// <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of 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>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    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).
    /// This method will fail if any of the following fields are not set:
    /// - [`retrieval_results`](crate::operation::retrieve::builders::RetrieveOutputBuilder::retrieval_results)
    pub fn build(self) -> ::std::result::Result<crate::operation::retrieve::RetrieveOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::retrieve::RetrieveOutput {
            retrieval_results: self.retrieval_results.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "retrieval_results",
                    "retrieval_results was not specified but it is required when building RetrieveOutput",
                )
            })?,
            guardrail_action: self.guardrail_action,
            next_token: self.next_token,
            _request_id: self._request_id,
        })
    }
}
impl ::std::fmt::Debug for RetrieveOutputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("RetrieveOutputBuilder");
        formatter.field("retrieval_results", &"*** Sensitive Data Redacted ***");
        formatter.field("guardrail_action", &self.guardrail_action);
        formatter.field("next_token", &self.next_token);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}