aws_sdk_athena/operation/get_session/
_get_session_output.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct GetSessionOutput {
6    /// <p>The session ID.</p>
7    pub session_id: ::std::option::Option<::std::string::String>,
8    /// <p>The session description.</p>
9    pub description: ::std::option::Option<::std::string::String>,
10    /// <p>The workgroup to which the session belongs.</p>
11    pub work_group: ::std::option::Option<::std::string::String>,
12    /// <p>The engine version used by the session (for example, <code>PySpark engine version 3</code>). You can get a list of engine versions by calling <code>ListEngineVersions</code>.</p>
13    pub engine_version: ::std::option::Option<::std::string::String>,
14    /// <p>Contains engine configuration information like DPU usage.</p>
15    pub engine_configuration: ::std::option::Option<crate::types::EngineConfiguration>,
16    /// <p>The notebook version.</p>
17    pub notebook_version: ::std::option::Option<::std::string::String>,
18    /// <p>Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.</p>
19    pub monitoring_configuration: ::std::option::Option<crate::types::MonitoringConfiguration>,
20    /// <p>Contains the workgroup configuration information used by the session.</p>
21    pub session_configuration: ::std::option::Option<crate::types::SessionConfiguration>,
22    /// <p>Contains information about the status of the session.</p>
23    pub status: ::std::option::Option<crate::types::SessionStatus>,
24    /// <p>Contains the DPU execution time.</p>
25    pub statistics: ::std::option::Option<crate::types::SessionStatistics>,
26    _request_id: Option<String>,
27}
28impl GetSessionOutput {
29    /// <p>The session ID.</p>
30    pub fn session_id(&self) -> ::std::option::Option<&str> {
31        self.session_id.as_deref()
32    }
33    /// <p>The session description.</p>
34    pub fn description(&self) -> ::std::option::Option<&str> {
35        self.description.as_deref()
36    }
37    /// <p>The workgroup to which the session belongs.</p>
38    pub fn work_group(&self) -> ::std::option::Option<&str> {
39        self.work_group.as_deref()
40    }
41    /// <p>The engine version used by the session (for example, <code>PySpark engine version 3</code>). You can get a list of engine versions by calling <code>ListEngineVersions</code>.</p>
42    pub fn engine_version(&self) -> ::std::option::Option<&str> {
43        self.engine_version.as_deref()
44    }
45    /// <p>Contains engine configuration information like DPU usage.</p>
46    pub fn engine_configuration(&self) -> ::std::option::Option<&crate::types::EngineConfiguration> {
47        self.engine_configuration.as_ref()
48    }
49    /// <p>The notebook version.</p>
50    pub fn notebook_version(&self) -> ::std::option::Option<&str> {
51        self.notebook_version.as_deref()
52    }
53    /// <p>Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.</p>
54    pub fn monitoring_configuration(&self) -> ::std::option::Option<&crate::types::MonitoringConfiguration> {
55        self.monitoring_configuration.as_ref()
56    }
57    /// <p>Contains the workgroup configuration information used by the session.</p>
58    pub fn session_configuration(&self) -> ::std::option::Option<&crate::types::SessionConfiguration> {
59        self.session_configuration.as_ref()
60    }
61    /// <p>Contains information about the status of the session.</p>
62    pub fn status(&self) -> ::std::option::Option<&crate::types::SessionStatus> {
63        self.status.as_ref()
64    }
65    /// <p>Contains the DPU execution time.</p>
66    pub fn statistics(&self) -> ::std::option::Option<&crate::types::SessionStatistics> {
67        self.statistics.as_ref()
68    }
69}
70impl ::aws_types::request_id::RequestId for GetSessionOutput {
71    fn request_id(&self) -> Option<&str> {
72        self._request_id.as_deref()
73    }
74}
75impl GetSessionOutput {
76    /// Creates a new builder-style object to manufacture [`GetSessionOutput`](crate::operation::get_session::GetSessionOutput).
77    pub fn builder() -> crate::operation::get_session::builders::GetSessionOutputBuilder {
78        crate::operation::get_session::builders::GetSessionOutputBuilder::default()
79    }
80}
81
82/// A builder for [`GetSessionOutput`](crate::operation::get_session::GetSessionOutput).
83#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
84#[non_exhaustive]
85pub struct GetSessionOutputBuilder {
86    pub(crate) session_id: ::std::option::Option<::std::string::String>,
87    pub(crate) description: ::std::option::Option<::std::string::String>,
88    pub(crate) work_group: ::std::option::Option<::std::string::String>,
89    pub(crate) engine_version: ::std::option::Option<::std::string::String>,
90    pub(crate) engine_configuration: ::std::option::Option<crate::types::EngineConfiguration>,
91    pub(crate) notebook_version: ::std::option::Option<::std::string::String>,
92    pub(crate) monitoring_configuration: ::std::option::Option<crate::types::MonitoringConfiguration>,
93    pub(crate) session_configuration: ::std::option::Option<crate::types::SessionConfiguration>,
94    pub(crate) status: ::std::option::Option<crate::types::SessionStatus>,
95    pub(crate) statistics: ::std::option::Option<crate::types::SessionStatistics>,
96    _request_id: Option<String>,
97}
98impl GetSessionOutputBuilder {
99    /// <p>The session ID.</p>
100    pub fn session_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
101        self.session_id = ::std::option::Option::Some(input.into());
102        self
103    }
104    /// <p>The session ID.</p>
105    pub fn set_session_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
106        self.session_id = input;
107        self
108    }
109    /// <p>The session ID.</p>
110    pub fn get_session_id(&self) -> &::std::option::Option<::std::string::String> {
111        &self.session_id
112    }
113    /// <p>The session description.</p>
114    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.description = ::std::option::Option::Some(input.into());
116        self
117    }
118    /// <p>The session description.</p>
119    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.description = input;
121        self
122    }
123    /// <p>The session description.</p>
124    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
125        &self.description
126    }
127    /// <p>The workgroup to which the session belongs.</p>
128    pub fn work_group(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.work_group = ::std::option::Option::Some(input.into());
130        self
131    }
132    /// <p>The workgroup to which the session belongs.</p>
133    pub fn set_work_group(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.work_group = input;
135        self
136    }
137    /// <p>The workgroup to which the session belongs.</p>
138    pub fn get_work_group(&self) -> &::std::option::Option<::std::string::String> {
139        &self.work_group
140    }
141    /// <p>The engine version used by the session (for example, <code>PySpark engine version 3</code>). You can get a list of engine versions by calling <code>ListEngineVersions</code>.</p>
142    pub fn engine_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.engine_version = ::std::option::Option::Some(input.into());
144        self
145    }
146    /// <p>The engine version used by the session (for example, <code>PySpark engine version 3</code>). You can get a list of engine versions by calling <code>ListEngineVersions</code>.</p>
147    pub fn set_engine_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.engine_version = input;
149        self
150    }
151    /// <p>The engine version used by the session (for example, <code>PySpark engine version 3</code>). You can get a list of engine versions by calling <code>ListEngineVersions</code>.</p>
152    pub fn get_engine_version(&self) -> &::std::option::Option<::std::string::String> {
153        &self.engine_version
154    }
155    /// <p>Contains engine configuration information like DPU usage.</p>
156    pub fn engine_configuration(mut self, input: crate::types::EngineConfiguration) -> Self {
157        self.engine_configuration = ::std::option::Option::Some(input);
158        self
159    }
160    /// <p>Contains engine configuration information like DPU usage.</p>
161    pub fn set_engine_configuration(mut self, input: ::std::option::Option<crate::types::EngineConfiguration>) -> Self {
162        self.engine_configuration = input;
163        self
164    }
165    /// <p>Contains engine configuration information like DPU usage.</p>
166    pub fn get_engine_configuration(&self) -> &::std::option::Option<crate::types::EngineConfiguration> {
167        &self.engine_configuration
168    }
169    /// <p>The notebook version.</p>
170    pub fn notebook_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171        self.notebook_version = ::std::option::Option::Some(input.into());
172        self
173    }
174    /// <p>The notebook version.</p>
175    pub fn set_notebook_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176        self.notebook_version = input;
177        self
178    }
179    /// <p>The notebook version.</p>
180    pub fn get_notebook_version(&self) -> &::std::option::Option<::std::string::String> {
181        &self.notebook_version
182    }
183    /// <p>Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.</p>
184    pub fn monitoring_configuration(mut self, input: crate::types::MonitoringConfiguration) -> Self {
185        self.monitoring_configuration = ::std::option::Option::Some(input);
186        self
187    }
188    /// <p>Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.</p>
189    pub fn set_monitoring_configuration(mut self, input: ::std::option::Option<crate::types::MonitoringConfiguration>) -> Self {
190        self.monitoring_configuration = input;
191        self
192    }
193    /// <p>Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.</p>
194    pub fn get_monitoring_configuration(&self) -> &::std::option::Option<crate::types::MonitoringConfiguration> {
195        &self.monitoring_configuration
196    }
197    /// <p>Contains the workgroup configuration information used by the session.</p>
198    pub fn session_configuration(mut self, input: crate::types::SessionConfiguration) -> Self {
199        self.session_configuration = ::std::option::Option::Some(input);
200        self
201    }
202    /// <p>Contains the workgroup configuration information used by the session.</p>
203    pub fn set_session_configuration(mut self, input: ::std::option::Option<crate::types::SessionConfiguration>) -> Self {
204        self.session_configuration = input;
205        self
206    }
207    /// <p>Contains the workgroup configuration information used by the session.</p>
208    pub fn get_session_configuration(&self) -> &::std::option::Option<crate::types::SessionConfiguration> {
209        &self.session_configuration
210    }
211    /// <p>Contains information about the status of the session.</p>
212    pub fn status(mut self, input: crate::types::SessionStatus) -> Self {
213        self.status = ::std::option::Option::Some(input);
214        self
215    }
216    /// <p>Contains information about the status of the session.</p>
217    pub fn set_status(mut self, input: ::std::option::Option<crate::types::SessionStatus>) -> Self {
218        self.status = input;
219        self
220    }
221    /// <p>Contains information about the status of the session.</p>
222    pub fn get_status(&self) -> &::std::option::Option<crate::types::SessionStatus> {
223        &self.status
224    }
225    /// <p>Contains the DPU execution time.</p>
226    pub fn statistics(mut self, input: crate::types::SessionStatistics) -> Self {
227        self.statistics = ::std::option::Option::Some(input);
228        self
229    }
230    /// <p>Contains the DPU execution time.</p>
231    pub fn set_statistics(mut self, input: ::std::option::Option<crate::types::SessionStatistics>) -> Self {
232        self.statistics = input;
233        self
234    }
235    /// <p>Contains the DPU execution time.</p>
236    pub fn get_statistics(&self) -> &::std::option::Option<crate::types::SessionStatistics> {
237        &self.statistics
238    }
239    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
240        self._request_id = Some(request_id.into());
241        self
242    }
243
244    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
245        self._request_id = request_id;
246        self
247    }
248    /// Consumes the builder and constructs a [`GetSessionOutput`](crate::operation::get_session::GetSessionOutput).
249    pub fn build(self) -> crate::operation::get_session::GetSessionOutput {
250        crate::operation::get_session::GetSessionOutput {
251            session_id: self.session_id,
252            description: self.description,
253            work_group: self.work_group,
254            engine_version: self.engine_version,
255            engine_configuration: self.engine_configuration,
256            notebook_version: self.notebook_version,
257            monitoring_configuration: self.monitoring_configuration,
258            session_configuration: self.session_configuration,
259            status: self.status,
260            statistics: self.statistics,
261            _request_id: self._request_id,
262        }
263    }
264}