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
// 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 DescribeAgentsInput {
/// <p>The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.</p>
pub agent_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example:</p>
/// <p><code>{"key": "collectionStatus", "value": "STARTED"}</code></p>
pub filters: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>,
/// <p>The total number of agents/collectors to return in a single page of output. The maximum value is 100.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>Token to retrieve the next set of results. For example, if you previously specified 100 IDs for <code>DescribeAgentsRequest$agentIds</code> but set <code>DescribeAgentsRequest$maxResults</code> to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.</p>
pub next_token: ::std::option::Option<::std::string::String>,
}
impl DescribeAgentsInput {
/// <p>The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.</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 `.agent_ids.is_none()`.
pub fn agent_ids(&self) -> &[::std::string::String] {
self.agent_ids.as_deref().unwrap_or_default()
}
/// <p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example:</p>
/// <p><code>{"key": "collectionStatus", "value": "STARTED"}</code></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 `.filters.is_none()`.
pub fn filters(&self) -> &[crate::types::Filter] {
self.filters.as_deref().unwrap_or_default()
}
/// <p>The total number of agents/collectors to return in a single page of output. The maximum value is 100.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>Token to retrieve the next set of results. For example, if you previously specified 100 IDs for <code>DescribeAgentsRequest$agentIds</code> but set <code>DescribeAgentsRequest$maxResults</code> to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
}
impl DescribeAgentsInput {
/// Creates a new builder-style object to manufacture [`DescribeAgentsInput`](crate::operation::describe_agents::DescribeAgentsInput).
pub fn builder() -> crate::operation::describe_agents::builders::DescribeAgentsInputBuilder {
crate::operation::describe_agents::builders::DescribeAgentsInputBuilder::default()
}
}
/// A builder for [`DescribeAgentsInput`](crate::operation::describe_agents::DescribeAgentsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeAgentsInputBuilder {
pub(crate) agent_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>,
pub(crate) max_results: ::std::option::Option<i32>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
}
impl DescribeAgentsInputBuilder {
/// Appends an item to `agent_ids`.
///
/// To override the contents of this collection use [`set_agent_ids`](Self::set_agent_ids).
///
/// <p>The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.</p>
pub fn agent_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.agent_ids.unwrap_or_default();
v.push(input.into());
self.agent_ids = ::std::option::Option::Some(v);
self
}
/// <p>The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.</p>
pub fn set_agent_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.agent_ids = input;
self
}
/// <p>The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.</p>
pub fn get_agent_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.agent_ids
}
/// Appends an item to `filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example:</p>
/// <p><code>{"key": "collectionStatus", "value": "STARTED"}</code></p>
pub fn filters(mut self, input: crate::types::Filter) -> Self {
let mut v = self.filters.unwrap_or_default();
v.push(input);
self.filters = ::std::option::Option::Some(v);
self
}
/// <p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example:</p>
/// <p><code>{"key": "collectionStatus", "value": "STARTED"}</code></p>
pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
self.filters = input;
self
}
/// <p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example:</p>
/// <p><code>{"key": "collectionStatus", "value": "STARTED"}</code></p>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
&self.filters
}
/// <p>The total number of agents/collectors to return in a single page of output. The maximum value is 100.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>The total number of agents/collectors to return in a single page of output. The maximum value is 100.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>The total number of agents/collectors to return in a single page of output. The maximum value is 100.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>Token to retrieve the next set of results. For example, if you previously specified 100 IDs for <code>DescribeAgentsRequest$agentIds</code> but set <code>DescribeAgentsRequest$maxResults</code> to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.next_token = ::std::option::Option::Some(input.into());
self
}
/// <p>Token to retrieve the next set of results. For example, if you previously specified 100 IDs for <code>DescribeAgentsRequest$agentIds</code> but set <code>DescribeAgentsRequest$maxResults</code> to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>Token to retrieve the next set of results. For example, if you previously specified 100 IDs for <code>DescribeAgentsRequest$agentIds</code> but set <code>DescribeAgentsRequest$maxResults</code> to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// Consumes the builder and constructs a [`DescribeAgentsInput`](crate::operation::describe_agents::DescribeAgentsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::describe_agents::DescribeAgentsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::describe_agents::DescribeAgentsInput {
agent_ids: self.agent_ids,
filters: self.filters,
max_results: self.max_results,
next_token: self.next_token,
})
}
}