aws_sdk_sagemaker/operation/describe_pipeline/
_describe_pipeline_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 DescribePipelineOutput {
6    /// <p>The Amazon Resource Name (ARN) of the pipeline.</p>
7    pub pipeline_arn: ::std::option::Option<::std::string::String>,
8    /// <p>The name of the pipeline.</p>
9    pub pipeline_name: ::std::option::Option<::std::string::String>,
10    /// <p>The display name of the pipeline.</p>
11    pub pipeline_display_name: ::std::option::Option<::std::string::String>,
12    /// <p>The JSON pipeline definition.</p>
13    pub pipeline_definition: ::std::option::Option<::std::string::String>,
14    /// <p>The description of the pipeline.</p>
15    pub pipeline_description: ::std::option::Option<::std::string::String>,
16    /// <p>The Amazon Resource Name (ARN) that the pipeline uses to execute.</p>
17    pub role_arn: ::std::option::Option<::std::string::String>,
18    /// <p>The status of the pipeline execution.</p>
19    pub pipeline_status: ::std::option::Option<crate::types::PipelineStatus>,
20    /// <p>The time when the pipeline was created.</p>
21    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
22    /// <p>The time when the pipeline was last modified.</p>
23    pub last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
24    /// <p>The time when the pipeline was last run.</p>
25    pub last_run_time: ::std::option::Option<::aws_smithy_types::DateTime>,
26    /// <p>Information about the user who created or modified a SageMaker resource.</p>
27    pub created_by: ::std::option::Option<crate::types::UserContext>,
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    /// <p>Lists the parallelism configuration applied to the pipeline.</p>
31    pub parallelism_configuration: ::std::option::Option<crate::types::ParallelismConfiguration>,
32    /// <p>The display name of the pipeline version.</p>
33    pub pipeline_version_display_name: ::std::option::Option<::std::string::String>,
34    /// <p>The description of the pipeline version.</p>
35    pub pipeline_version_description: ::std::option::Option<::std::string::String>,
36    _request_id: Option<String>,
37}
38impl DescribePipelineOutput {
39    /// <p>The Amazon Resource Name (ARN) of the pipeline.</p>
40    pub fn pipeline_arn(&self) -> ::std::option::Option<&str> {
41        self.pipeline_arn.as_deref()
42    }
43    /// <p>The name of the pipeline.</p>
44    pub fn pipeline_name(&self) -> ::std::option::Option<&str> {
45        self.pipeline_name.as_deref()
46    }
47    /// <p>The display name of the pipeline.</p>
48    pub fn pipeline_display_name(&self) -> ::std::option::Option<&str> {
49        self.pipeline_display_name.as_deref()
50    }
51    /// <p>The JSON pipeline definition.</p>
52    pub fn pipeline_definition(&self) -> ::std::option::Option<&str> {
53        self.pipeline_definition.as_deref()
54    }
55    /// <p>The description of the pipeline.</p>
56    pub fn pipeline_description(&self) -> ::std::option::Option<&str> {
57        self.pipeline_description.as_deref()
58    }
59    /// <p>The Amazon Resource Name (ARN) that the pipeline uses to execute.</p>
60    pub fn role_arn(&self) -> ::std::option::Option<&str> {
61        self.role_arn.as_deref()
62    }
63    /// <p>The status of the pipeline execution.</p>
64    pub fn pipeline_status(&self) -> ::std::option::Option<&crate::types::PipelineStatus> {
65        self.pipeline_status.as_ref()
66    }
67    /// <p>The time when the pipeline was created.</p>
68    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
69        self.creation_time.as_ref()
70    }
71    /// <p>The time when the pipeline was last modified.</p>
72    pub fn last_modified_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
73        self.last_modified_time.as_ref()
74    }
75    /// <p>The time when the pipeline was last run.</p>
76    pub fn last_run_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
77        self.last_run_time.as_ref()
78    }
79    /// <p>Information about the user who created or modified a SageMaker resource.</p>
80    pub fn created_by(&self) -> ::std::option::Option<&crate::types::UserContext> {
81        self.created_by.as_ref()
82    }
83    /// <p>Information about the user who created or modified a SageMaker resource.</p>
84    pub fn last_modified_by(&self) -> ::std::option::Option<&crate::types::UserContext> {
85        self.last_modified_by.as_ref()
86    }
87    /// <p>Lists the parallelism configuration applied to the pipeline.</p>
88    pub fn parallelism_configuration(&self) -> ::std::option::Option<&crate::types::ParallelismConfiguration> {
89        self.parallelism_configuration.as_ref()
90    }
91    /// <p>The display name of the pipeline version.</p>
92    pub fn pipeline_version_display_name(&self) -> ::std::option::Option<&str> {
93        self.pipeline_version_display_name.as_deref()
94    }
95    /// <p>The description of the pipeline version.</p>
96    pub fn pipeline_version_description(&self) -> ::std::option::Option<&str> {
97        self.pipeline_version_description.as_deref()
98    }
99}
100impl ::aws_types::request_id::RequestId for DescribePipelineOutput {
101    fn request_id(&self) -> Option<&str> {
102        self._request_id.as_deref()
103    }
104}
105impl DescribePipelineOutput {
106    /// Creates a new builder-style object to manufacture [`DescribePipelineOutput`](crate::operation::describe_pipeline::DescribePipelineOutput).
107    pub fn builder() -> crate::operation::describe_pipeline::builders::DescribePipelineOutputBuilder {
108        crate::operation::describe_pipeline::builders::DescribePipelineOutputBuilder::default()
109    }
110}
111
112/// A builder for [`DescribePipelineOutput`](crate::operation::describe_pipeline::DescribePipelineOutput).
113#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
114#[non_exhaustive]
115pub struct DescribePipelineOutputBuilder {
116    pub(crate) pipeline_arn: ::std::option::Option<::std::string::String>,
117    pub(crate) pipeline_name: ::std::option::Option<::std::string::String>,
118    pub(crate) pipeline_display_name: ::std::option::Option<::std::string::String>,
119    pub(crate) pipeline_definition: ::std::option::Option<::std::string::String>,
120    pub(crate) pipeline_description: ::std::option::Option<::std::string::String>,
121    pub(crate) role_arn: ::std::option::Option<::std::string::String>,
122    pub(crate) pipeline_status: ::std::option::Option<crate::types::PipelineStatus>,
123    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
124    pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
125    pub(crate) last_run_time: ::std::option::Option<::aws_smithy_types::DateTime>,
126    pub(crate) created_by: ::std::option::Option<crate::types::UserContext>,
127    pub(crate) last_modified_by: ::std::option::Option<crate::types::UserContext>,
128    pub(crate) parallelism_configuration: ::std::option::Option<crate::types::ParallelismConfiguration>,
129    pub(crate) pipeline_version_display_name: ::std::option::Option<::std::string::String>,
130    pub(crate) pipeline_version_description: ::std::option::Option<::std::string::String>,
131    _request_id: Option<String>,
132}
133impl DescribePipelineOutputBuilder {
134    /// <p>The Amazon Resource Name (ARN) of the pipeline.</p>
135    pub fn pipeline_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
136        self.pipeline_arn = ::std::option::Option::Some(input.into());
137        self
138    }
139    /// <p>The Amazon Resource Name (ARN) of the pipeline.</p>
140    pub fn set_pipeline_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
141        self.pipeline_arn = input;
142        self
143    }
144    /// <p>The Amazon Resource Name (ARN) of the pipeline.</p>
145    pub fn get_pipeline_arn(&self) -> &::std::option::Option<::std::string::String> {
146        &self.pipeline_arn
147    }
148    /// <p>The name of the pipeline.</p>
149    pub fn pipeline_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
150        self.pipeline_name = ::std::option::Option::Some(input.into());
151        self
152    }
153    /// <p>The name of the pipeline.</p>
154    pub fn set_pipeline_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
155        self.pipeline_name = input;
156        self
157    }
158    /// <p>The name of the pipeline.</p>
159    pub fn get_pipeline_name(&self) -> &::std::option::Option<::std::string::String> {
160        &self.pipeline_name
161    }
162    /// <p>The display name of the pipeline.</p>
163    pub fn pipeline_display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
164        self.pipeline_display_name = ::std::option::Option::Some(input.into());
165        self
166    }
167    /// <p>The display name of the pipeline.</p>
168    pub fn set_pipeline_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
169        self.pipeline_display_name = input;
170        self
171    }
172    /// <p>The display name of the pipeline.</p>
173    pub fn get_pipeline_display_name(&self) -> &::std::option::Option<::std::string::String> {
174        &self.pipeline_display_name
175    }
176    /// <p>The JSON pipeline definition.</p>
177    pub fn pipeline_definition(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
178        self.pipeline_definition = ::std::option::Option::Some(input.into());
179        self
180    }
181    /// <p>The JSON pipeline definition.</p>
182    pub fn set_pipeline_definition(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
183        self.pipeline_definition = input;
184        self
185    }
186    /// <p>The JSON pipeline definition.</p>
187    pub fn get_pipeline_definition(&self) -> &::std::option::Option<::std::string::String> {
188        &self.pipeline_definition
189    }
190    /// <p>The description of the pipeline.</p>
191    pub fn pipeline_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
192        self.pipeline_description = ::std::option::Option::Some(input.into());
193        self
194    }
195    /// <p>The description of the pipeline.</p>
196    pub fn set_pipeline_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
197        self.pipeline_description = input;
198        self
199    }
200    /// <p>The description of the pipeline.</p>
201    pub fn get_pipeline_description(&self) -> &::std::option::Option<::std::string::String> {
202        &self.pipeline_description
203    }
204    /// <p>The Amazon Resource Name (ARN) that the pipeline uses to execute.</p>
205    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
206        self.role_arn = ::std::option::Option::Some(input.into());
207        self
208    }
209    /// <p>The Amazon Resource Name (ARN) that the pipeline uses to execute.</p>
210    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
211        self.role_arn = input;
212        self
213    }
214    /// <p>The Amazon Resource Name (ARN) that the pipeline uses to execute.</p>
215    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
216        &self.role_arn
217    }
218    /// <p>The status of the pipeline execution.</p>
219    pub fn pipeline_status(mut self, input: crate::types::PipelineStatus) -> Self {
220        self.pipeline_status = ::std::option::Option::Some(input);
221        self
222    }
223    /// <p>The status of the pipeline execution.</p>
224    pub fn set_pipeline_status(mut self, input: ::std::option::Option<crate::types::PipelineStatus>) -> Self {
225        self.pipeline_status = input;
226        self
227    }
228    /// <p>The status of the pipeline execution.</p>
229    pub fn get_pipeline_status(&self) -> &::std::option::Option<crate::types::PipelineStatus> {
230        &self.pipeline_status
231    }
232    /// <p>The time when the pipeline was created.</p>
233    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
234        self.creation_time = ::std::option::Option::Some(input);
235        self
236    }
237    /// <p>The time when the pipeline was created.</p>
238    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
239        self.creation_time = input;
240        self
241    }
242    /// <p>The time when the pipeline was created.</p>
243    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
244        &self.creation_time
245    }
246    /// <p>The time when the pipeline was last modified.</p>
247    pub fn last_modified_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
248        self.last_modified_time = ::std::option::Option::Some(input);
249        self
250    }
251    /// <p>The time when the pipeline was last modified.</p>
252    pub fn set_last_modified_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
253        self.last_modified_time = input;
254        self
255    }
256    /// <p>The time when the pipeline was last modified.</p>
257    pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
258        &self.last_modified_time
259    }
260    /// <p>The time when the pipeline was last run.</p>
261    pub fn last_run_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
262        self.last_run_time = ::std::option::Option::Some(input);
263        self
264    }
265    /// <p>The time when the pipeline was last run.</p>
266    pub fn set_last_run_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
267        self.last_run_time = input;
268        self
269    }
270    /// <p>The time when the pipeline was last run.</p>
271    pub fn get_last_run_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
272        &self.last_run_time
273    }
274    /// <p>Information about the user who created or modified a SageMaker resource.</p>
275    pub fn created_by(mut self, input: crate::types::UserContext) -> Self {
276        self.created_by = ::std::option::Option::Some(input);
277        self
278    }
279    /// <p>Information about the user who created or modified a SageMaker resource.</p>
280    pub fn set_created_by(mut self, input: ::std::option::Option<crate::types::UserContext>) -> Self {
281        self.created_by = input;
282        self
283    }
284    /// <p>Information about the user who created or modified a SageMaker resource.</p>
285    pub fn get_created_by(&self) -> &::std::option::Option<crate::types::UserContext> {
286        &self.created_by
287    }
288    /// <p>Information about the user who created or modified a SageMaker resource.</p>
289    pub fn last_modified_by(mut self, input: crate::types::UserContext) -> Self {
290        self.last_modified_by = ::std::option::Option::Some(input);
291        self
292    }
293    /// <p>Information about the user who created or modified a SageMaker resource.</p>
294    pub fn set_last_modified_by(mut self, input: ::std::option::Option<crate::types::UserContext>) -> Self {
295        self.last_modified_by = input;
296        self
297    }
298    /// <p>Information about the user who created or modified a SageMaker resource.</p>
299    pub fn get_last_modified_by(&self) -> &::std::option::Option<crate::types::UserContext> {
300        &self.last_modified_by
301    }
302    /// <p>Lists the parallelism configuration applied to the pipeline.</p>
303    pub fn parallelism_configuration(mut self, input: crate::types::ParallelismConfiguration) -> Self {
304        self.parallelism_configuration = ::std::option::Option::Some(input);
305        self
306    }
307    /// <p>Lists the parallelism configuration applied to the pipeline.</p>
308    pub fn set_parallelism_configuration(mut self, input: ::std::option::Option<crate::types::ParallelismConfiguration>) -> Self {
309        self.parallelism_configuration = input;
310        self
311    }
312    /// <p>Lists the parallelism configuration applied to the pipeline.</p>
313    pub fn get_parallelism_configuration(&self) -> &::std::option::Option<crate::types::ParallelismConfiguration> {
314        &self.parallelism_configuration
315    }
316    /// <p>The display name of the pipeline version.</p>
317    pub fn pipeline_version_display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
318        self.pipeline_version_display_name = ::std::option::Option::Some(input.into());
319        self
320    }
321    /// <p>The display name of the pipeline version.</p>
322    pub fn set_pipeline_version_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
323        self.pipeline_version_display_name = input;
324        self
325    }
326    /// <p>The display name of the pipeline version.</p>
327    pub fn get_pipeline_version_display_name(&self) -> &::std::option::Option<::std::string::String> {
328        &self.pipeline_version_display_name
329    }
330    /// <p>The description of the pipeline version.</p>
331    pub fn pipeline_version_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
332        self.pipeline_version_description = ::std::option::Option::Some(input.into());
333        self
334    }
335    /// <p>The description of the pipeline version.</p>
336    pub fn set_pipeline_version_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
337        self.pipeline_version_description = input;
338        self
339    }
340    /// <p>The description of the pipeline version.</p>
341    pub fn get_pipeline_version_description(&self) -> &::std::option::Option<::std::string::String> {
342        &self.pipeline_version_description
343    }
344    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
345        self._request_id = Some(request_id.into());
346        self
347    }
348
349    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
350        self._request_id = request_id;
351        self
352    }
353    /// Consumes the builder and constructs a [`DescribePipelineOutput`](crate::operation::describe_pipeline::DescribePipelineOutput).
354    pub fn build(self) -> crate::operation::describe_pipeline::DescribePipelineOutput {
355        crate::operation::describe_pipeline::DescribePipelineOutput {
356            pipeline_arn: self.pipeline_arn,
357            pipeline_name: self.pipeline_name,
358            pipeline_display_name: self.pipeline_display_name,
359            pipeline_definition: self.pipeline_definition,
360            pipeline_description: self.pipeline_description,
361            role_arn: self.role_arn,
362            pipeline_status: self.pipeline_status,
363            creation_time: self.creation_time,
364            last_modified_time: self.last_modified_time,
365            last_run_time: self.last_run_time,
366            created_by: self.created_by,
367            last_modified_by: self.last_modified_by,
368            parallelism_configuration: self.parallelism_configuration,
369            pipeline_version_display_name: self.pipeline_version_display_name,
370            pipeline_version_description: self.pipeline_version_description,
371            _request_id: self._request_id,
372        }
373    }
374}