aws_sdk_applicationdiscovery/operation/describe_agents/
_describe_agents_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 DescribeAgentsOutput {
6    /// <p>Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.</p>
7    pub agents_info: ::std::option::Option<::std::vec::Vec<crate::types::AgentInfo>>,
8    /// <p>Token to retrieve the next set of results. For example, if you 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 this token. Use this token in the next query to retrieve the next set of 10.</p>
9    pub next_token: ::std::option::Option<::std::string::String>,
10    _request_id: Option<String>,
11}
12impl DescribeAgentsOutput {
13    /// <p>Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.</p>
14    ///
15    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.agents_info.is_none()`.
16    pub fn agents_info(&self) -> &[crate::types::AgentInfo] {
17        self.agents_info.as_deref().unwrap_or_default()
18    }
19    /// <p>Token to retrieve the next set of results. For example, if you 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 this token. Use this token in the next query to retrieve the next set of 10.</p>
20    pub fn next_token(&self) -> ::std::option::Option<&str> {
21        self.next_token.as_deref()
22    }
23}
24impl ::aws_types::request_id::RequestId for DescribeAgentsOutput {
25    fn request_id(&self) -> Option<&str> {
26        self._request_id.as_deref()
27    }
28}
29impl DescribeAgentsOutput {
30    /// Creates a new builder-style object to manufacture [`DescribeAgentsOutput`](crate::operation::describe_agents::DescribeAgentsOutput).
31    pub fn builder() -> crate::operation::describe_agents::builders::DescribeAgentsOutputBuilder {
32        crate::operation::describe_agents::builders::DescribeAgentsOutputBuilder::default()
33    }
34}
35
36/// A builder for [`DescribeAgentsOutput`](crate::operation::describe_agents::DescribeAgentsOutput).
37#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
38#[non_exhaustive]
39pub struct DescribeAgentsOutputBuilder {
40    pub(crate) agents_info: ::std::option::Option<::std::vec::Vec<crate::types::AgentInfo>>,
41    pub(crate) next_token: ::std::option::Option<::std::string::String>,
42    _request_id: Option<String>,
43}
44impl DescribeAgentsOutputBuilder {
45    /// Appends an item to `agents_info`.
46    ///
47    /// To override the contents of this collection use [`set_agents_info`](Self::set_agents_info).
48    ///
49    /// <p>Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.</p>
50    pub fn agents_info(mut self, input: crate::types::AgentInfo) -> Self {
51        let mut v = self.agents_info.unwrap_or_default();
52        v.push(input);
53        self.agents_info = ::std::option::Option::Some(v);
54        self
55    }
56    /// <p>Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.</p>
57    pub fn set_agents_info(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AgentInfo>>) -> Self {
58        self.agents_info = input;
59        self
60    }
61    /// <p>Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.</p>
62    pub fn get_agents_info(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AgentInfo>> {
63        &self.agents_info
64    }
65    /// <p>Token to retrieve the next set of results. For example, if you 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 this token. Use this token in the next query to retrieve the next set of 10.</p>
66    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
67        self.next_token = ::std::option::Option::Some(input.into());
68        self
69    }
70    /// <p>Token to retrieve the next set of results. For example, if you 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 this token. Use this token in the next query to retrieve the next set of 10.</p>
71    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
72        self.next_token = input;
73        self
74    }
75    /// <p>Token to retrieve the next set of results. For example, if you 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 this token. Use this token in the next query to retrieve the next set of 10.</p>
76    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
77        &self.next_token
78    }
79    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
80        self._request_id = Some(request_id.into());
81        self
82    }
83
84    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
85        self._request_id = request_id;
86        self
87    }
88    /// Consumes the builder and constructs a [`DescribeAgentsOutput`](crate::operation::describe_agents::DescribeAgentsOutput).
89    pub fn build(self) -> crate::operation::describe_agents::DescribeAgentsOutput {
90        crate::operation::describe_agents::DescribeAgentsOutput {
91            agents_info: self.agents_info,
92            next_token: self.next_token,
93            _request_id: self._request_id,
94        }
95    }
96}
aws_sdk_applicationdiscovery/operation/describe_agents/_describe_agents_output.rs

aws_sdk_applicationdiscovery/operation/describe_agents/
_describe_agents_output.rs
