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
// 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 GetQueryResultsOutput {
/// <p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
pub query_language: ::std::option::Option<crate::types::QueryLanguage>,
/// <p>The log events that matched the query criteria during the most recent time it ran.</p>
/// <p>The <code>results</code> value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of <code>field</code>/<code>value</code> pairs.</p>
pub results: ::std::option::Option<::std::vec::Vec<::std::vec::Vec<crate::types::ResultField>>>,
/// <p>Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.</p>
pub statistics: ::std::option::Option<crate::types::QueryStatistics>,
/// <p>The status of the most recent running of the query. Possible values are <code>Cancelled</code>, <code>Complete</code>, <code>Failed</code>, <code>Running</code>, <code>Scheduled</code>, <code>Timeout</code>, and <code>Unknown</code>.</p>
/// <p>Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.</p>
pub status: ::std::option::Option<crate::types::QueryStatus>,
/// <p>If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> stores them.</p>
pub encryption_key: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl GetQueryResultsOutput {
/// <p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
pub fn query_language(&self) -> ::std::option::Option<&crate::types::QueryLanguage> {
self.query_language.as_ref()
}
/// <p>The log events that matched the query criteria during the most recent time it ran.</p>
/// <p>The <code>results</code> value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of <code>field</code>/<code>value</code> pairs.</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 `.results.is_none()`.
pub fn results(&self) -> &[::std::vec::Vec<crate::types::ResultField>] {
self.results.as_deref().unwrap_or_default()
}
/// <p>Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.</p>
pub fn statistics(&self) -> ::std::option::Option<&crate::types::QueryStatistics> {
self.statistics.as_ref()
}
/// <p>The status of the most recent running of the query. Possible values are <code>Cancelled</code>, <code>Complete</code>, <code>Failed</code>, <code>Running</code>, <code>Scheduled</code>, <code>Timeout</code>, and <code>Unknown</code>.</p>
/// <p>Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.</p>
pub fn status(&self) -> ::std::option::Option<&crate::types::QueryStatus> {
self.status.as_ref()
}
/// <p>If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> stores them.</p>
pub fn encryption_key(&self) -> ::std::option::Option<&str> {
self.encryption_key.as_deref()
}
}
impl ::aws_types::request_id::RequestId for GetQueryResultsOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl GetQueryResultsOutput {
/// Creates a new builder-style object to manufacture [`GetQueryResultsOutput`](crate::operation::get_query_results::GetQueryResultsOutput).
pub fn builder() -> crate::operation::get_query_results::builders::GetQueryResultsOutputBuilder {
crate::operation::get_query_results::builders::GetQueryResultsOutputBuilder::default()
}
}
/// A builder for [`GetQueryResultsOutput`](crate::operation::get_query_results::GetQueryResultsOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetQueryResultsOutputBuilder {
pub(crate) query_language: ::std::option::Option<crate::types::QueryLanguage>,
pub(crate) results: ::std::option::Option<::std::vec::Vec<::std::vec::Vec<crate::types::ResultField>>>,
pub(crate) statistics: ::std::option::Option<crate::types::QueryStatistics>,
pub(crate) status: ::std::option::Option<crate::types::QueryStatus>,
pub(crate) encryption_key: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl GetQueryResultsOutputBuilder {
/// <p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
pub fn query_language(mut self, input: crate::types::QueryLanguage) -> Self {
self.query_language = ::std::option::Option::Some(input);
self
}
/// <p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
pub fn set_query_language(mut self, input: ::std::option::Option<crate::types::QueryLanguage>) -> Self {
self.query_language = input;
self
}
/// <p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
pub fn get_query_language(&self) -> &::std::option::Option<crate::types::QueryLanguage> {
&self.query_language
}
/// Appends an item to `results`.
///
/// To override the contents of this collection use [`set_results`](Self::set_results).
///
/// <p>The log events that matched the query criteria during the most recent time it ran.</p>
/// <p>The <code>results</code> value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of <code>field</code>/<code>value</code> pairs.</p>
pub fn results(mut self, input: ::std::vec::Vec<crate::types::ResultField>) -> Self {
let mut v = self.results.unwrap_or_default();
v.push(input);
self.results = ::std::option::Option::Some(v);
self
}
/// <p>The log events that matched the query criteria during the most recent time it ran.</p>
/// <p>The <code>results</code> value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of <code>field</code>/<code>value</code> pairs.</p>
pub fn set_results(mut self, input: ::std::option::Option<::std::vec::Vec<::std::vec::Vec<crate::types::ResultField>>>) -> Self {
self.results = input;
self
}
/// <p>The log events that matched the query criteria during the most recent time it ran.</p>
/// <p>The <code>results</code> value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of <code>field</code>/<code>value</code> pairs.</p>
pub fn get_results(&self) -> &::std::option::Option<::std::vec::Vec<::std::vec::Vec<crate::types::ResultField>>> {
&self.results
}
/// <p>Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.</p>
pub fn statistics(mut self, input: crate::types::QueryStatistics) -> Self {
self.statistics = ::std::option::Option::Some(input);
self
}
/// <p>Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.</p>
pub fn set_statistics(mut self, input: ::std::option::Option<crate::types::QueryStatistics>) -> Self {
self.statistics = input;
self
}
/// <p>Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.</p>
pub fn get_statistics(&self) -> &::std::option::Option<crate::types::QueryStatistics> {
&self.statistics
}
/// <p>The status of the most recent running of the query. Possible values are <code>Cancelled</code>, <code>Complete</code>, <code>Failed</code>, <code>Running</code>, <code>Scheduled</code>, <code>Timeout</code>, and <code>Unknown</code>.</p>
/// <p>Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.</p>
pub fn status(mut self, input: crate::types::QueryStatus) -> Self {
self.status = ::std::option::Option::Some(input);
self
}
/// <p>The status of the most recent running of the query. Possible values are <code>Cancelled</code>, <code>Complete</code>, <code>Failed</code>, <code>Running</code>, <code>Scheduled</code>, <code>Timeout</code>, and <code>Unknown</code>.</p>
/// <p>Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.</p>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::QueryStatus>) -> Self {
self.status = input;
self
}
/// <p>The status of the most recent running of the query. Possible values are <code>Cancelled</code>, <code>Complete</code>, <code>Failed</code>, <code>Running</code>, <code>Scheduled</code>, <code>Timeout</code>, and <code>Unknown</code>.</p>
/// <p>Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.</p>
pub fn get_status(&self) -> &::std::option::Option<crate::types::QueryStatus> {
&self.status
}
/// <p>If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> stores them.</p>
pub fn encryption_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.encryption_key = ::std::option::Option::Some(input.into());
self
}
/// <p>If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> stores them.</p>
pub fn set_encryption_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.encryption_key = input;
self
}
/// <p>If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> stores them.</p>
pub fn get_encryption_key(&self) -> &::std::option::Option<::std::string::String> {
&self.encryption_key
}
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 [`GetQueryResultsOutput`](crate::operation::get_query_results::GetQueryResultsOutput).
pub fn build(self) -> crate::operation::get_query_results::GetQueryResultsOutput {
crate::operation::get_query_results::GetQueryResultsOutput {
query_language: self.query_language,
results: self.results,
statistics: self.statistics,
status: self.status,
encryption_key: self.encryption_key,
_request_id: self._request_id,
}
}
}