aws-sdk-ssm 1.112.0

AWS SDK for Amazon Simple Systems Manager (SSM)
Documentation
// 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 DescribeSessionsInput {
    /// <p>The session status to retrieve a list of sessions for. For example, "Active".</p>
    pub state: ::std::option::Option<crate::types::SessionState>,
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub max_results: ::std::option::Option<i32>,
    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>One or more filters to limit the type of sessions returned by the request.</p>
    pub filters: ::std::option::Option<::std::vec::Vec<crate::types::SessionFilter>>,
}
impl DescribeSessionsInput {
    /// <p>The session status to retrieve a list of sessions for. For example, "Active".</p>
    pub fn state(&self) -> ::std::option::Option<&crate::types::SessionState> {
        self.state.as_ref()
    }
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>One or more filters to limit the type of sessions returned by the request.</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::SessionFilter] {
        self.filters.as_deref().unwrap_or_default()
    }
}
impl DescribeSessionsInput {
    /// Creates a new builder-style object to manufacture [`DescribeSessionsInput`](crate::operation::describe_sessions::DescribeSessionsInput).
    pub fn builder() -> crate::operation::describe_sessions::builders::DescribeSessionsInputBuilder {
        crate::operation::describe_sessions::builders::DescribeSessionsInputBuilder::default()
    }
}

/// A builder for [`DescribeSessionsInput`](crate::operation::describe_sessions::DescribeSessionsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeSessionsInputBuilder {
    pub(crate) state: ::std::option::Option<crate::types::SessionState>,
    pub(crate) max_results: ::std::option::Option<i32>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::SessionFilter>>,
}
impl DescribeSessionsInputBuilder {
    /// <p>The session status to retrieve a list of sessions for. For example, "Active".</p>
    /// This field is required.
    pub fn state(mut self, input: crate::types::SessionState) -> Self {
        self.state = ::std::option::Option::Some(input);
        self
    }
    /// <p>The session status to retrieve a list of sessions for. For example, "Active".</p>
    pub fn set_state(mut self, input: ::std::option::Option<crate::types::SessionState>) -> Self {
        self.state = input;
        self
    }
    /// <p>The session status to retrieve a list of sessions for. For example, "Active".</p>
    pub fn get_state(&self) -> &::std::option::Option<crate::types::SessionState> {
        &self.state
    }
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.max_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.max_results = input;
        self
    }
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</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>The token for the next set of items to return. (You received this token from a previous call.)</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// Appends an item to `filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>One or more filters to limit the type of sessions returned by the request.</p>
    pub fn filters(mut self, input: crate::types::SessionFilter) -> Self {
        let mut v = self.filters.unwrap_or_default();
        v.push(input);
        self.filters = ::std::option::Option::Some(v);
        self
    }
    /// <p>One or more filters to limit the type of sessions returned by the request.</p>
    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SessionFilter>>) -> Self {
        self.filters = input;
        self
    }
    /// <p>One or more filters to limit the type of sessions returned by the request.</p>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SessionFilter>> {
        &self.filters
    }
    /// Consumes the builder and constructs a [`DescribeSessionsInput`](crate::operation::describe_sessions::DescribeSessionsInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::describe_sessions::DescribeSessionsInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::describe_sessions::DescribeSessionsInput {
            state: self.state,
            max_results: self.max_results,
            next_token: self.next_token,
            filters: self.filters,
        })
    }
}