aws_sdk_deadline/operation/search_steps/
_search_steps_input.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct SearchStepsInput {
    /// <p>The farm ID to use for the step search.</p>
    pub farm_id: ::std::option::Option<::std::string::String>,
    /// <p>The queue IDs in the step search.</p>
    pub queue_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The job ID to use in the step search.</p>
    pub job_id: ::std::option::Option<::std::string::String>,
    /// <p>The filter expression, <code>AND</code> or <code>OR</code>, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis <code>()</code>.</p>
    pub filter_expressions: ::std::option::Option<crate::types::SearchGroupedFilterExpressions>,
    /// <p>The search terms for a resource.</p>
    pub sort_expressions: ::std::option::Option<::std::vec::Vec<crate::types::SearchSortExpression>>,
    /// <p>Defines how far into the scrollable list to start the return of results.</p>
    pub item_offset: ::std::option::Option<i32>,
    /// <p>Specifies the number of items per page for the resource.</p>
    pub page_size: ::std::option::Option<i32>,
}
impl SearchStepsInput {
    /// <p>The farm ID to use for the step search.</p>
    pub fn farm_id(&self) -> ::std::option::Option<&str> {
        self.farm_id.as_deref()
    }
    /// <p>The queue IDs in the step search.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.queue_ids.is_none()`.
    pub fn queue_ids(&self) -> &[::std::string::String] {
        self.queue_ids.as_deref().unwrap_or_default()
    }
    /// <p>The job ID to use in the step search.</p>
    pub fn job_id(&self) -> ::std::option::Option<&str> {
        self.job_id.as_deref()
    }
    /// <p>The filter expression, <code>AND</code> or <code>OR</code>, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis <code>()</code>.</p>
    pub fn filter_expressions(&self) -> ::std::option::Option<&crate::types::SearchGroupedFilterExpressions> {
        self.filter_expressions.as_ref()
    }
    /// <p>The search terms for a resource.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.sort_expressions.is_none()`.
    pub fn sort_expressions(&self) -> &[crate::types::SearchSortExpression] {
        self.sort_expressions.as_deref().unwrap_or_default()
    }
    /// <p>Defines how far into the scrollable list to start the return of results.</p>
    pub fn item_offset(&self) -> ::std::option::Option<i32> {
        self.item_offset
    }
    /// <p>Specifies the number of items per page for the resource.</p>
    pub fn page_size(&self) -> ::std::option::Option<i32> {
        self.page_size
    }
}
impl SearchStepsInput {
    /// Creates a new builder-style object to manufacture [`SearchStepsInput`](crate::operation::search_steps::SearchStepsInput).
    pub fn builder() -> crate::operation::search_steps::builders::SearchStepsInputBuilder {
        crate::operation::search_steps::builders::SearchStepsInputBuilder::default()
    }
}

/// A builder for [`SearchStepsInput`](crate::operation::search_steps::SearchStepsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SearchStepsInputBuilder {
    pub(crate) farm_id: ::std::option::Option<::std::string::String>,
    pub(crate) queue_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) job_id: ::std::option::Option<::std::string::String>,
    pub(crate) filter_expressions: ::std::option::Option<crate::types::SearchGroupedFilterExpressions>,
    pub(crate) sort_expressions: ::std::option::Option<::std::vec::Vec<crate::types::SearchSortExpression>>,
    pub(crate) item_offset: ::std::option::Option<i32>,
    pub(crate) page_size: ::std::option::Option<i32>,
}
impl SearchStepsInputBuilder {
    /// <p>The farm ID to use for the step search.</p>
    /// This field is required.
    pub fn farm_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.farm_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The farm ID to use for the step search.</p>
    pub fn set_farm_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.farm_id = input;
        self
    }
    /// <p>The farm ID to use for the step search.</p>
    pub fn get_farm_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.farm_id
    }
    /// Appends an item to `queue_ids`.
    ///
    /// To override the contents of this collection use [`set_queue_ids`](Self::set_queue_ids).
    ///
    /// <p>The queue IDs in the step search.</p>
    pub fn queue_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.queue_ids.unwrap_or_default();
        v.push(input.into());
        self.queue_ids = ::std::option::Option::Some(v);
        self
    }
    /// <p>The queue IDs in the step search.</p>
    pub fn set_queue_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.queue_ids = input;
        self
    }
    /// <p>The queue IDs in the step search.</p>
    pub fn get_queue_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.queue_ids
    }
    /// <p>The job ID to use in the step search.</p>
    pub fn job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.job_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The job ID to use in the step search.</p>
    pub fn set_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.job_id = input;
        self
    }
    /// <p>The job ID to use in the step search.</p>
    pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.job_id
    }
    /// <p>The filter expression, <code>AND</code> or <code>OR</code>, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis <code>()</code>.</p>
    pub fn filter_expressions(mut self, input: crate::types::SearchGroupedFilterExpressions) -> Self {
        self.filter_expressions = ::std::option::Option::Some(input);
        self
    }
    /// <p>The filter expression, <code>AND</code> or <code>OR</code>, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis <code>()</code>.</p>
    pub fn set_filter_expressions(mut self, input: ::std::option::Option<crate::types::SearchGroupedFilterExpressions>) -> Self {
        self.filter_expressions = input;
        self
    }
    /// <p>The filter expression, <code>AND</code> or <code>OR</code>, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis <code>()</code>.</p>
    pub fn get_filter_expressions(&self) -> &::std::option::Option<crate::types::SearchGroupedFilterExpressions> {
        &self.filter_expressions
    }
    /// Appends an item to `sort_expressions`.
    ///
    /// To override the contents of this collection use [`set_sort_expressions`](Self::set_sort_expressions).
    ///
    /// <p>The search terms for a resource.</p>
    pub fn sort_expressions(mut self, input: crate::types::SearchSortExpression) -> Self {
        let mut v = self.sort_expressions.unwrap_or_default();
        v.push(input);
        self.sort_expressions = ::std::option::Option::Some(v);
        self
    }
    /// <p>The search terms for a resource.</p>
    pub fn set_sort_expressions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SearchSortExpression>>) -> Self {
        self.sort_expressions = input;
        self
    }
    /// <p>The search terms for a resource.</p>
    pub fn get_sort_expressions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SearchSortExpression>> {
        &self.sort_expressions
    }
    /// <p>Defines how far into the scrollable list to start the return of results.</p>
    /// This field is required.
    pub fn item_offset(mut self, input: i32) -> Self {
        self.item_offset = ::std::option::Option::Some(input);
        self
    }
    /// <p>Defines how far into the scrollable list to start the return of results.</p>
    pub fn set_item_offset(mut self, input: ::std::option::Option<i32>) -> Self {
        self.item_offset = input;
        self
    }
    /// <p>Defines how far into the scrollable list to start the return of results.</p>
    pub fn get_item_offset(&self) -> &::std::option::Option<i32> {
        &self.item_offset
    }
    /// <p>Specifies the number of items per page for the resource.</p>
    pub fn page_size(mut self, input: i32) -> Self {
        self.page_size = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies the number of items per page for the resource.</p>
    pub fn set_page_size(mut self, input: ::std::option::Option<i32>) -> Self {
        self.page_size = input;
        self
    }
    /// <p>Specifies the number of items per page for the resource.</p>
    pub fn get_page_size(&self) -> &::std::option::Option<i32> {
        &self.page_size
    }
    /// Consumes the builder and constructs a [`SearchStepsInput`](crate::operation::search_steps::SearchStepsInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::search_steps::SearchStepsInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::search_steps::SearchStepsInput {
            farm_id: self.farm_id,
            queue_ids: self.queue_ids,
            job_id: self.job_id,
            filter_expressions: self.filter_expressions,
            sort_expressions: self.sort_expressions,
            item_offset: self.item_offset,
            page_size: self.page_size,
        })
    }
}