aws_sdk_sagemaker/operation/describe_project/
_describe_project_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 DescribeProjectOutput {
6    /// <p>The Amazon Resource Name (ARN) of the project.</p>
7    pub project_arn: ::std::option::Option<::std::string::String>,
8    /// <p>The name of the project.</p>
9    pub project_name: ::std::option::Option<::std::string::String>,
10    /// <p>The ID of the project.</p>
11    pub project_id: ::std::option::Option<::std::string::String>,
12    /// <p>The description of the project.</p>
13    pub project_description: ::std::option::Option<::std::string::String>,
14    /// <p>Information used to provision a service catalog product. For information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>.</p>
15    pub service_catalog_provisioning_details: ::std::option::Option<crate::types::ServiceCatalogProvisioningDetails>,
16    /// <p>Information about a provisioned service catalog product.</p>
17    pub service_catalog_provisioned_product_details: ::std::option::Option<crate::types::ServiceCatalogProvisionedProductDetails>,
18    /// <p>The status of the project.</p>
19    pub project_status: ::std::option::Option<crate::types::ProjectStatus>,
20    /// <p>An array of template providers associated with the project.</p>
21    pub template_provider_details: ::std::option::Option<::std::vec::Vec<crate::types::TemplateProviderDetail>>,
22    /// <p>Information about the user who created or modified a SageMaker resource.</p>
23    pub created_by: ::std::option::Option<crate::types::UserContext>,
24    /// <p>The time when the project was created.</p>
25    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
26    /// <p>The timestamp when project was last modified.</p>
27    pub last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
28    /// <p>Information about the user who created or modified a SageMaker resource.</p>
29    pub last_modified_by: ::std::option::Option<crate::types::UserContext>,
30    _request_id: Option<String>,
31}
32impl DescribeProjectOutput {
33    /// <p>The Amazon Resource Name (ARN) of the project.</p>
34    pub fn project_arn(&self) -> ::std::option::Option<&str> {
35        self.project_arn.as_deref()
36    }
37    /// <p>The name of the project.</p>
38    pub fn project_name(&self) -> ::std::option::Option<&str> {
39        self.project_name.as_deref()
40    }
41    /// <p>The ID of the project.</p>
42    pub fn project_id(&self) -> ::std::option::Option<&str> {
43        self.project_id.as_deref()
44    }
45    /// <p>The description of the project.</p>
46    pub fn project_description(&self) -> ::std::option::Option<&str> {
47        self.project_description.as_deref()
48    }
49    /// <p>Information used to provision a service catalog product. For information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>.</p>
50    pub fn service_catalog_provisioning_details(&self) -> ::std::option::Option<&crate::types::ServiceCatalogProvisioningDetails> {
51        self.service_catalog_provisioning_details.as_ref()
52    }
53    /// <p>Information about a provisioned service catalog product.</p>
54    pub fn service_catalog_provisioned_product_details(&self) -> ::std::option::Option<&crate::types::ServiceCatalogProvisionedProductDetails> {
55        self.service_catalog_provisioned_product_details.as_ref()
56    }
57    /// <p>The status of the project.</p>
58    pub fn project_status(&self) -> ::std::option::Option<&crate::types::ProjectStatus> {
59        self.project_status.as_ref()
60    }
61    /// <p>An array of template providers associated with the project.</p>
62    ///
63    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.template_provider_details.is_none()`.
64    pub fn template_provider_details(&self) -> &[crate::types::TemplateProviderDetail] {
65        self.template_provider_details.as_deref().unwrap_or_default()
66    }
67    /// <p>Information about the user who created or modified a SageMaker resource.</p>
68    pub fn created_by(&self) -> ::std::option::Option<&crate::types::UserContext> {
69        self.created_by.as_ref()
70    }
71    /// <p>The time when the project was created.</p>
72    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
73        self.creation_time.as_ref()
74    }
75    /// <p>The timestamp when project was last modified.</p>
76    pub fn last_modified_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
77        self.last_modified_time.as_ref()
78    }
79    /// <p>Information about the user who created or modified a SageMaker resource.</p>
80    pub fn last_modified_by(&self) -> ::std::option::Option<&crate::types::UserContext> {
81        self.last_modified_by.as_ref()
82    }
83}
84impl ::aws_types::request_id::RequestId for DescribeProjectOutput {
85    fn request_id(&self) -> Option<&str> {
86        self._request_id.as_deref()
87    }
88}
89impl DescribeProjectOutput {
90    /// Creates a new builder-style object to manufacture [`DescribeProjectOutput`](crate::operation::describe_project::DescribeProjectOutput).
91    pub fn builder() -> crate::operation::describe_project::builders::DescribeProjectOutputBuilder {
92        crate::operation::describe_project::builders::DescribeProjectOutputBuilder::default()
93    }
94}
95
96/// A builder for [`DescribeProjectOutput`](crate::operation::describe_project::DescribeProjectOutput).
97#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
98#[non_exhaustive]
99pub struct DescribeProjectOutputBuilder {
100    pub(crate) project_arn: ::std::option::Option<::std::string::String>,
101    pub(crate) project_name: ::std::option::Option<::std::string::String>,
102    pub(crate) project_id: ::std::option::Option<::std::string::String>,
103    pub(crate) project_description: ::std::option::Option<::std::string::String>,
104    pub(crate) service_catalog_provisioning_details: ::std::option::Option<crate::types::ServiceCatalogProvisioningDetails>,
105    pub(crate) service_catalog_provisioned_product_details: ::std::option::Option<crate::types::ServiceCatalogProvisionedProductDetails>,
106    pub(crate) project_status: ::std::option::Option<crate::types::ProjectStatus>,
107    pub(crate) template_provider_details: ::std::option::Option<::std::vec::Vec<crate::types::TemplateProviderDetail>>,
108    pub(crate) created_by: ::std::option::Option<crate::types::UserContext>,
109    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
110    pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
111    pub(crate) last_modified_by: ::std::option::Option<crate::types::UserContext>,
112    _request_id: Option<String>,
113}
114impl DescribeProjectOutputBuilder {
115    /// <p>The Amazon Resource Name (ARN) of the project.</p>
116    /// This field is required.
117    pub fn project_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
118        self.project_arn = ::std::option::Option::Some(input.into());
119        self
120    }
121    /// <p>The Amazon Resource Name (ARN) of the project.</p>
122    pub fn set_project_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
123        self.project_arn = input;
124        self
125    }
126    /// <p>The Amazon Resource Name (ARN) of the project.</p>
127    pub fn get_project_arn(&self) -> &::std::option::Option<::std::string::String> {
128        &self.project_arn
129    }
130    /// <p>The name of the project.</p>
131    /// This field is required.
132    pub fn project_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.project_name = ::std::option::Option::Some(input.into());
134        self
135    }
136    /// <p>The name of the project.</p>
137    pub fn set_project_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.project_name = input;
139        self
140    }
141    /// <p>The name of the project.</p>
142    pub fn get_project_name(&self) -> &::std::option::Option<::std::string::String> {
143        &self.project_name
144    }
145    /// <p>The ID of the project.</p>
146    /// This field is required.
147    pub fn project_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
148        self.project_id = ::std::option::Option::Some(input.into());
149        self
150    }
151    /// <p>The ID of the project.</p>
152    pub fn set_project_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
153        self.project_id = input;
154        self
155    }
156    /// <p>The ID of the project.</p>
157    pub fn get_project_id(&self) -> &::std::option::Option<::std::string::String> {
158        &self.project_id
159    }
160    /// <p>The description of the project.</p>
161    pub fn project_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
162        self.project_description = ::std::option::Option::Some(input.into());
163        self
164    }
165    /// <p>The description of the project.</p>
166    pub fn set_project_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
167        self.project_description = input;
168        self
169    }
170    /// <p>The description of the project.</p>
171    pub fn get_project_description(&self) -> &::std::option::Option<::std::string::String> {
172        &self.project_description
173    }
174    /// <p>Information used to provision a service catalog product. For information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>.</p>
175    pub fn service_catalog_provisioning_details(mut self, input: crate::types::ServiceCatalogProvisioningDetails) -> Self {
176        self.service_catalog_provisioning_details = ::std::option::Option::Some(input);
177        self
178    }
179    /// <p>Information used to provision a service catalog product. For information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>.</p>
180    pub fn set_service_catalog_provisioning_details(mut self, input: ::std::option::Option<crate::types::ServiceCatalogProvisioningDetails>) -> Self {
181        self.service_catalog_provisioning_details = input;
182        self
183    }
184    /// <p>Information used to provision a service catalog product. For information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>.</p>
185    pub fn get_service_catalog_provisioning_details(&self) -> &::std::option::Option<crate::types::ServiceCatalogProvisioningDetails> {
186        &self.service_catalog_provisioning_details
187    }
188    /// <p>Information about a provisioned service catalog product.</p>
189    pub fn service_catalog_provisioned_product_details(mut self, input: crate::types::ServiceCatalogProvisionedProductDetails) -> Self {
190        self.service_catalog_provisioned_product_details = ::std::option::Option::Some(input);
191        self
192    }
193    /// <p>Information about a provisioned service catalog product.</p>
194    pub fn set_service_catalog_provisioned_product_details(
195        mut self,
196        input: ::std::option::Option<crate::types::ServiceCatalogProvisionedProductDetails>,
197    ) -> Self {
198        self.service_catalog_provisioned_product_details = input;
199        self
200    }
201    /// <p>Information about a provisioned service catalog product.</p>
202    pub fn get_service_catalog_provisioned_product_details(&self) -> &::std::option::Option<crate::types::ServiceCatalogProvisionedProductDetails> {
203        &self.service_catalog_provisioned_product_details
204    }
205    /// <p>The status of the project.</p>
206    /// This field is required.
207    pub fn project_status(mut self, input: crate::types::ProjectStatus) -> Self {
208        self.project_status = ::std::option::Option::Some(input);
209        self
210    }
211    /// <p>The status of the project.</p>
212    pub fn set_project_status(mut self, input: ::std::option::Option<crate::types::ProjectStatus>) -> Self {
213        self.project_status = input;
214        self
215    }
216    /// <p>The status of the project.</p>
217    pub fn get_project_status(&self) -> &::std::option::Option<crate::types::ProjectStatus> {
218        &self.project_status
219    }
220    /// Appends an item to `template_provider_details`.
221    ///
222    /// To override the contents of this collection use [`set_template_provider_details`](Self::set_template_provider_details).
223    ///
224    /// <p>An array of template providers associated with the project.</p>
225    pub fn template_provider_details(mut self, input: crate::types::TemplateProviderDetail) -> Self {
226        let mut v = self.template_provider_details.unwrap_or_default();
227        v.push(input);
228        self.template_provider_details = ::std::option::Option::Some(v);
229        self
230    }
231    /// <p>An array of template providers associated with the project.</p>
232    pub fn set_template_provider_details(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TemplateProviderDetail>>) -> Self {
233        self.template_provider_details = input;
234        self
235    }
236    /// <p>An array of template providers associated with the project.</p>
237    pub fn get_template_provider_details(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TemplateProviderDetail>> {
238        &self.template_provider_details
239    }
240    /// <p>Information about the user who created or modified a SageMaker resource.</p>
241    pub fn created_by(mut self, input: crate::types::UserContext) -> Self {
242        self.created_by = ::std::option::Option::Some(input);
243        self
244    }
245    /// <p>Information about the user who created or modified a SageMaker resource.</p>
246    pub fn set_created_by(mut self, input: ::std::option::Option<crate::types::UserContext>) -> Self {
247        self.created_by = input;
248        self
249    }
250    /// <p>Information about the user who created or modified a SageMaker resource.</p>
251    pub fn get_created_by(&self) -> &::std::option::Option<crate::types::UserContext> {
252        &self.created_by
253    }
254    /// <p>The time when the project was created.</p>
255    /// This field is required.
256    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
257        self.creation_time = ::std::option::Option::Some(input);
258        self
259    }
260    /// <p>The time when the project was created.</p>
261    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
262        self.creation_time = input;
263        self
264    }
265    /// <p>The time when the project was created.</p>
266    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
267        &self.creation_time
268    }
269    /// <p>The timestamp when project was last modified.</p>
270    pub fn last_modified_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
271        self.last_modified_time = ::std::option::Option::Some(input);
272        self
273    }
274    /// <p>The timestamp when project was last modified.</p>
275    pub fn set_last_modified_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
276        self.last_modified_time = input;
277        self
278    }
279    /// <p>The timestamp when project was last modified.</p>
280    pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
281        &self.last_modified_time
282    }
283    /// <p>Information about the user who created or modified a SageMaker resource.</p>
284    pub fn last_modified_by(mut self, input: crate::types::UserContext) -> Self {
285        self.last_modified_by = ::std::option::Option::Some(input);
286        self
287    }
288    /// <p>Information about the user who created or modified a SageMaker resource.</p>
289    pub fn set_last_modified_by(mut self, input: ::std::option::Option<crate::types::UserContext>) -> Self {
290        self.last_modified_by = input;
291        self
292    }
293    /// <p>Information about the user who created or modified a SageMaker resource.</p>
294    pub fn get_last_modified_by(&self) -> &::std::option::Option<crate::types::UserContext> {
295        &self.last_modified_by
296    }
297    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
298        self._request_id = Some(request_id.into());
299        self
300    }
301
302    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
303        self._request_id = request_id;
304        self
305    }
306    /// Consumes the builder and constructs a [`DescribeProjectOutput`](crate::operation::describe_project::DescribeProjectOutput).
307    pub fn build(self) -> crate::operation::describe_project::DescribeProjectOutput {
308        crate::operation::describe_project::DescribeProjectOutput {
309            project_arn: self.project_arn,
310            project_name: self.project_name,
311            project_id: self.project_id,
312            project_description: self.project_description,
313            service_catalog_provisioning_details: self.service_catalog_provisioning_details,
314            service_catalog_provisioned_product_details: self.service_catalog_provisioned_product_details,
315            project_status: self.project_status,
316            template_provider_details: self.template_provider_details,
317            created_by: self.created_by,
318            creation_time: self.creation_time,
319            last_modified_time: self.last_modified_time,
320            last_modified_by: self.last_modified_by,
321            _request_id: self._request_id,
322        }
323    }
324}