aws_sdk_datapipeline/operation/describe_objects/_describe_objects_input.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// <p>Contains the parameters for DescribeObjects.</p>
4#[non_exhaustive]
5#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
6pub struct DescribeObjectsInput {
7 /// <p>The ID of the pipeline that contains the object definitions.</p>
8 pub pipeline_id: ::std::option::Option<::std::string::String>,
9 /// <p>The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to <code>DescribeObjects</code>.</p>
10 pub object_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
11 /// <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>
12 pub evaluate_expressions: ::std::option::Option<bool>,
13 /// <p>The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>DescribeObjects</code> with the marker value from the previous call to retrieve the next set of results.</p>
14 pub marker: ::std::option::Option<::std::string::String>,
15}
16impl DescribeObjectsInput {
17 /// <p>The ID of the pipeline that contains the object definitions.</p>
18 pub fn pipeline_id(&self) -> ::std::option::Option<&str> {
19 self.pipeline_id.as_deref()
20 }
21 /// <p>The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to <code>DescribeObjects</code>.</p>
22 ///
23 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.object_ids.is_none()`.
24 pub fn object_ids(&self) -> &[::std::string::String] {
25 self.object_ids.as_deref().unwrap_or_default()
26 }
27 /// <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>
28 pub fn evaluate_expressions(&self) -> ::std::option::Option<bool> {
29 self.evaluate_expressions
30 }
31 /// <p>The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>DescribeObjects</code> with the marker value from the previous call to retrieve the next set of results.</p>
32 pub fn marker(&self) -> ::std::option::Option<&str> {
33 self.marker.as_deref()
34 }
35}
36impl DescribeObjectsInput {
37 /// Creates a new builder-style object to manufacture [`DescribeObjectsInput`](crate::operation::describe_objects::DescribeObjectsInput).
38 pub fn builder() -> crate::operation::describe_objects::builders::DescribeObjectsInputBuilder {
39 crate::operation::describe_objects::builders::DescribeObjectsInputBuilder::default()
40 }
41}
42
43/// A builder for [`DescribeObjectsInput`](crate::operation::describe_objects::DescribeObjectsInput).
44#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
45#[non_exhaustive]
46pub struct DescribeObjectsInputBuilder {
47 pub(crate) pipeline_id: ::std::option::Option<::std::string::String>,
48 pub(crate) object_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
49 pub(crate) evaluate_expressions: ::std::option::Option<bool>,
50 pub(crate) marker: ::std::option::Option<::std::string::String>,
51}
52impl DescribeObjectsInputBuilder {
53 /// <p>The ID of the pipeline that contains the object definitions.</p>
54 /// This field is required.
55 pub fn pipeline_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
56 self.pipeline_id = ::std::option::Option::Some(input.into());
57 self
58 }
59 /// <p>The ID of the pipeline that contains the object definitions.</p>
60 pub fn set_pipeline_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
61 self.pipeline_id = input;
62 self
63 }
64 /// <p>The ID of the pipeline that contains the object definitions.</p>
65 pub fn get_pipeline_id(&self) -> &::std::option::Option<::std::string::String> {
66 &self.pipeline_id
67 }
68 /// Appends an item to `object_ids`.
69 ///
70 /// To override the contents of this collection use [`set_object_ids`](Self::set_object_ids).
71 ///
72 /// <p>The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to <code>DescribeObjects</code>.</p>
73 pub fn object_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
74 let mut v = self.object_ids.unwrap_or_default();
75 v.push(input.into());
76 self.object_ids = ::std::option::Option::Some(v);
77 self
78 }
79 /// <p>The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to <code>DescribeObjects</code>.</p>
80 pub fn set_object_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
81 self.object_ids = input;
82 self
83 }
84 /// <p>The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to <code>DescribeObjects</code>.</p>
85 pub fn get_object_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
86 &self.object_ids
87 }
88 /// <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>
89 pub fn evaluate_expressions(mut self, input: bool) -> Self {
90 self.evaluate_expressions = ::std::option::Option::Some(input);
91 self
92 }
93 /// <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>
94 pub fn set_evaluate_expressions(mut self, input: ::std::option::Option<bool>) -> Self {
95 self.evaluate_expressions = input;
96 self
97 }
98 /// <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>
99 pub fn get_evaluate_expressions(&self) -> &::std::option::Option<bool> {
100 &self.evaluate_expressions
101 }
102 /// <p>The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>DescribeObjects</code> with the marker value from the previous call to retrieve the next set of results.</p>
103 pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
104 self.marker = ::std::option::Option::Some(input.into());
105 self
106 }
107 /// <p>The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>DescribeObjects</code> with the marker value from the previous call to retrieve the next set of results.</p>
108 pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
109 self.marker = input;
110 self
111 }
112 /// <p>The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>DescribeObjects</code> with the marker value from the previous call to retrieve the next set of results.</p>
113 pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
114 &self.marker
115 }
116 /// Consumes the builder and constructs a [`DescribeObjectsInput`](crate::operation::describe_objects::DescribeObjectsInput).
117 pub fn build(
118 self,
119 ) -> ::std::result::Result<crate::operation::describe_objects::DescribeObjectsInput, ::aws_smithy_types::error::operation::BuildError> {
120 ::std::result::Result::Ok(crate::operation::describe_objects::DescribeObjectsInput {
121 pipeline_id: self.pipeline_id,
122 object_ids: self.object_ids,
123 evaluate_expressions: self.evaluate_expressions,
124 marker: self.marker,
125 })
126 }
127}