Struct DescribeAgentsInputBuilder

#[non_exhaustive]
pub struct DescribeAgentsInputBuilder { /* private fields */ }

A builder for DescribeAgentsInput.

Implementations

impl DescribeAgentsInputBuilder

pub fn agent_ids(self, input: impl Into<String>) -> Self

Appends an item to agent_ids.

To override the contents of this collection use set_agent_ids.

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.

pub fn set_agent_ids(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_agent_ids(&self) -> &Option<Vec<String>>

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.

pub fn filters(self, input: Filter) -> Self

Appends an item to filters.

To override the contents of this collection use set_filters.

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

pub fn get_filters(&self) -> &Option<Vec<Filter>>

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

pub fn max_results(self, input: i32) -> Self

The total number of agents/collectors to return in a single page of output. The maximum value is 100.

pub fn set_max_results(self, input: Option<i32>) -> Self

The total number of agents/collectors to return in a single page of output. The maximum value is 100.

pub fn get_max_results(&self) -> &Option<i32>

The total number of agents/collectors to return in a single page of output. The maximum value is 100.

pub fn next_token(self, input: impl Into<String>) -> Self

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults 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.

pub fn set_next_token(self, input: Option<String>) -> Self

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults 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.

pub fn get_next_token(&self) -> &Option<String>

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults 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.

pub fn build(self) -> Result<DescribeAgentsInput, BuildError>

Consumes the builder and constructs a DescribeAgentsInput.

impl DescribeAgentsInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<DescribeAgentsOutput, SdkError<DescribeAgentsError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for DescribeAgentsInputBuilder

fn clone(&self) -> DescribeAgentsInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeAgentsInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DescribeAgentsInputBuilder

fn default() -> DescribeAgentsInputBuilder

Returns the “default value” for a type.

impl PartialEq for DescribeAgentsInputBuilder

fn eq(&self, other: &DescribeAgentsInputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeAgentsInputBuilder