aws_sdk_deadline/operation/search_steps/
_search_steps_output.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
// 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 SearchStepsOutput {
    /// <p>The steps in the search.</p>
    pub steps: ::std::vec::Vec<crate::types::StepSearchSummary>,
    /// <p>The next incremental starting point after the defined <code>itemOffset</code>.</p>
    pub next_item_offset: ::std::option::Option<i32>,
    /// <p>The total number of results in the search.</p>
    pub total_results: i32,
    _request_id: Option<String>,
}
impl SearchStepsOutput {
    /// <p>The steps in the search.</p>
    pub fn steps(&self) -> &[crate::types::StepSearchSummary] {
        use std::ops::Deref;
        self.steps.deref()
    }
    /// <p>The next incremental starting point after the defined <code>itemOffset</code>.</p>
    pub fn next_item_offset(&self) -> ::std::option::Option<i32> {
        self.next_item_offset
    }
    /// <p>The total number of results in the search.</p>
    pub fn total_results(&self) -> i32 {
        self.total_results
    }
}
impl ::aws_types::request_id::RequestId for SearchStepsOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl SearchStepsOutput {
    /// Creates a new builder-style object to manufacture [`SearchStepsOutput`](crate::operation::search_steps::SearchStepsOutput).
    pub fn builder() -> crate::operation::search_steps::builders::SearchStepsOutputBuilder {
        crate::operation::search_steps::builders::SearchStepsOutputBuilder::default()
    }
}

/// A builder for [`SearchStepsOutput`](crate::operation::search_steps::SearchStepsOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SearchStepsOutputBuilder {
    pub(crate) steps: ::std::option::Option<::std::vec::Vec<crate::types::StepSearchSummary>>,
    pub(crate) next_item_offset: ::std::option::Option<i32>,
    pub(crate) total_results: ::std::option::Option<i32>,
    _request_id: Option<String>,
}
impl SearchStepsOutputBuilder {
    /// Appends an item to `steps`.
    ///
    /// To override the contents of this collection use [`set_steps`](Self::set_steps).
    ///
    /// <p>The steps in the search.</p>
    pub fn steps(mut self, input: crate::types::StepSearchSummary) -> Self {
        let mut v = self.steps.unwrap_or_default();
        v.push(input);
        self.steps = ::std::option::Option::Some(v);
        self
    }
    /// <p>The steps in the search.</p>
    pub fn set_steps(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::StepSearchSummary>>) -> Self {
        self.steps = input;
        self
    }
    /// <p>The steps in the search.</p>
    pub fn get_steps(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::StepSearchSummary>> {
        &self.steps
    }
    /// <p>The next incremental starting point after the defined <code>itemOffset</code>.</p>
    pub fn next_item_offset(mut self, input: i32) -> Self {
        self.next_item_offset = ::std::option::Option::Some(input);
        self
    }
    /// <p>The next incremental starting point after the defined <code>itemOffset</code>.</p>
    pub fn set_next_item_offset(mut self, input: ::std::option::Option<i32>) -> Self {
        self.next_item_offset = input;
        self
    }
    /// <p>The next incremental starting point after the defined <code>itemOffset</code>.</p>
    pub fn get_next_item_offset(&self) -> &::std::option::Option<i32> {
        &self.next_item_offset
    }
    /// <p>The total number of results in the search.</p>
    /// This field is required.
    pub fn total_results(mut self, input: i32) -> Self {
        self.total_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>The total number of results in the search.</p>
    pub fn set_total_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.total_results = input;
        self
    }
    /// <p>The total number of results in the search.</p>
    pub fn get_total_results(&self) -> &::std::option::Option<i32> {
        &self.total_results
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`SearchStepsOutput`](crate::operation::search_steps::SearchStepsOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`steps`](crate::operation::search_steps::builders::SearchStepsOutputBuilder::steps)
    /// - [`total_results`](crate::operation::search_steps::builders::SearchStepsOutputBuilder::total_results)
    pub fn build(self) -> ::std::result::Result<crate::operation::search_steps::SearchStepsOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::search_steps::SearchStepsOutput {
            steps: self.steps.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "steps",
                    "steps was not specified but it is required when building SearchStepsOutput",
                )
            })?,
            next_item_offset: self.next_item_offset,
            total_results: self.total_results.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "total_results",
                    "total_results was not specified but it is required when building SearchStepsOutput",
                )
            })?,
            _request_id: self._request_id,
        })
    }
}