aws-sdk-timestreamquery 1.105.0

AWS SDK for Amazon Timestream Query
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
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

// 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 QueryOutput {
    /// <p>A unique ID for the given query.</p>
    pub query_id: ::std::string::String,
    /// <p>A pagination token that can be used again on a <code>Query</code> call to get the next set of results.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>The result set rows returned by the query.</p>
    pub rows: ::std::vec::Vec<crate::types::Row>,
    /// <p>The column data types of the returned result set.</p>
    pub column_info: ::std::vec::Vec<crate::types::ColumnInfo>,
    /// <p>Information about the status of the query, including progress and bytes scanned.</p>
    pub query_status: ::std::option::Option<crate::types::QueryStatus>,
    /// <p>Encapsulates <code>QueryInsights</code> containing insights and metrics related to the query that you executed.</p>
    pub query_insights_response: ::std::option::Option<crate::types::QueryInsightsResponse>,
    _request_id: Option<String>,
}
impl QueryOutput {
    /// <p>A unique ID for the given query.</p>
    pub fn query_id(&self) -> &str {
        use std::ops::Deref;
        self.query_id.deref()
    }
    /// <p>A pagination token that can be used again on a <code>Query</code> call to get the next set of results.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>The result set rows returned by the query.</p>
    pub fn rows(&self) -> &[crate::types::Row] {
        use std::ops::Deref;
        self.rows.deref()
    }
    /// <p>The column data types of the returned result set.</p>
    pub fn column_info(&self) -> &[crate::types::ColumnInfo] {
        use std::ops::Deref;
        self.column_info.deref()
    }
    /// <p>Information about the status of the query, including progress and bytes scanned.</p>
    pub fn query_status(&self) -> ::std::option::Option<&crate::types::QueryStatus> {
        self.query_status.as_ref()
    }
    /// <p>Encapsulates <code>QueryInsights</code> containing insights and metrics related to the query that you executed.</p>
    pub fn query_insights_response(&self) -> ::std::option::Option<&crate::types::QueryInsightsResponse> {
        self.query_insights_response.as_ref()
    }
}
impl ::aws_types::request_id::RequestId for QueryOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl QueryOutput {
    /// Creates a new builder-style object to manufacture [`QueryOutput`](crate::operation::query::QueryOutput).
    pub fn builder() -> crate::operation::query::builders::QueryOutputBuilder {
        crate::operation::query::builders::QueryOutputBuilder::default()
    }
}

/// A builder for [`QueryOutput`](crate::operation::query::QueryOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct QueryOutputBuilder {
    pub(crate) query_id: ::std::option::Option<::std::string::String>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) rows: ::std::option::Option<::std::vec::Vec<crate::types::Row>>,
    pub(crate) column_info: ::std::option::Option<::std::vec::Vec<crate::types::ColumnInfo>>,
    pub(crate) query_status: ::std::option::Option<crate::types::QueryStatus>,
    pub(crate) query_insights_response: ::std::option::Option<crate::types::QueryInsightsResponse>,
    _request_id: Option<String>,
}
impl QueryOutputBuilder {
    /// <p>A unique ID for the given query.</p>
    /// This field is required.
    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>A unique ID for the given query.</p>
    pub fn set_query_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.query_id = input;
        self
    }
    /// <p>A unique ID for the given query.</p>
    pub fn get_query_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.query_id
    }
    /// <p>A pagination token that can be used again on a <code>Query</code> call to get the next set 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>A pagination token that can be used again on a <code>Query</code> call to get the next set of results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>A pagination token that can be used again on a <code>Query</code> call to get the next set of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// Appends an item to `rows`.
    ///
    /// To override the contents of this collection use [`set_rows`](Self::set_rows).
    ///
    /// <p>The result set rows returned by the query.</p>
    pub fn rows(mut self, input: crate::types::Row) -> Self {
        let mut v = self.rows.unwrap_or_default();
        v.push(input);
        self.rows = ::std::option::Option::Some(v);
        self
    }
    /// <p>The result set rows returned by the query.</p>
    pub fn set_rows(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Row>>) -> Self {
        self.rows = input;
        self
    }
    /// <p>The result set rows returned by the query.</p>
    pub fn get_rows(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Row>> {
        &self.rows
    }
    /// Appends an item to `column_info`.
    ///
    /// To override the contents of this collection use [`set_column_info`](Self::set_column_info).
    ///
    /// <p>The column data types of the returned result set.</p>
    pub fn column_info(mut self, input: crate::types::ColumnInfo) -> Self {
        let mut v = self.column_info.unwrap_or_default();
        v.push(input);
        self.column_info = ::std::option::Option::Some(v);
        self
    }
    /// <p>The column data types of the returned result set.</p>
    pub fn set_column_info(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ColumnInfo>>) -> Self {
        self.column_info = input;
        self
    }
    /// <p>The column data types of the returned result set.</p>
    pub fn get_column_info(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ColumnInfo>> {
        &self.column_info
    }
    /// <p>Information about the status of the query, including progress and bytes scanned.</p>
    pub fn query_status(mut self, input: crate::types::QueryStatus) -> Self {
        self.query_status = ::std::option::Option::Some(input);
        self
    }
    /// <p>Information about the status of the query, including progress and bytes scanned.</p>
    pub fn set_query_status(mut self, input: ::std::option::Option<crate::types::QueryStatus>) -> Self {
        self.query_status = input;
        self
    }
    /// <p>Information about the status of the query, including progress and bytes scanned.</p>
    pub fn get_query_status(&self) -> &::std::option::Option<crate::types::QueryStatus> {
        &self.query_status
    }
    /// <p>Encapsulates <code>QueryInsights</code> containing insights and metrics related to the query that you executed.</p>
    pub fn query_insights_response(mut self, input: crate::types::QueryInsightsResponse) -> Self {
        self.query_insights_response = ::std::option::Option::Some(input);
        self
    }
    /// <p>Encapsulates <code>QueryInsights</code> containing insights and metrics related to the query that you executed.</p>
    pub fn set_query_insights_response(mut self, input: ::std::option::Option<crate::types::QueryInsightsResponse>) -> Self {
        self.query_insights_response = input;
        self
    }
    /// <p>Encapsulates <code>QueryInsights</code> containing insights and metrics related to the query that you executed.</p>
    pub fn get_query_insights_response(&self) -> &::std::option::Option<crate::types::QueryInsightsResponse> {
        &self.query_insights_response
    }
    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 [`QueryOutput`](crate::operation::query::QueryOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`query_id`](crate::operation::query::builders::QueryOutputBuilder::query_id)
    /// - [`rows`](crate::operation::query::builders::QueryOutputBuilder::rows)
    /// - [`column_info`](crate::operation::query::builders::QueryOutputBuilder::column_info)
    pub fn build(self) -> ::std::result::Result<crate::operation::query::QueryOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::query::QueryOutput {
            query_id: self.query_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "query_id",
                    "query_id was not specified but it is required when building QueryOutput",
                )
            })?,
            next_token: self.next_token,
            rows: self.rows.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "rows",
                    "rows was not specified but it is required when building QueryOutput",
                )
            })?,
            column_info: self.column_info.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "column_info",
                    "column_info was not specified but it is required when building QueryOutput",
                )
            })?,
            query_status: self.query_status,
            query_insights_response: self.query_insights_response,
            _request_id: self._request_id,
        })
    }
}