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