aws-sdk-gamelift 0.26.0

AWS SDK for Amazon GameLift
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 ListLocationsInput {
    /// <p>Filters the list for <code>AWS</code> or <code>CUSTOM</code> locations.</p>
    #[doc(hidden)]
    pub filters: std::option::Option<std::vec::Vec<crate::types::LocationFilter>>,
    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
    #[doc(hidden)]
    pub limit: std::option::Option<i32>,
    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
    #[doc(hidden)]
    pub next_token: std::option::Option<std::string::String>,
}
impl ListLocationsInput {
    /// <p>Filters the list for <code>AWS</code> or <code>CUSTOM</code> locations.</p>
    pub fn filters(&self) -> std::option::Option<&[crate::types::LocationFilter]> {
        self.filters.as_deref()
    }
    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
    pub fn limit(&self) -> std::option::Option<i32> {
        self.limit
    }
    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
    pub fn next_token(&self) -> std::option::Option<&str> {
        self.next_token.as_deref()
    }
}
impl ListLocationsInput {
    /// Creates a new builder-style object to manufacture [`ListLocationsInput`](crate::operation::list_locations::ListLocationsInput).
    pub fn builder() -> crate::operation::list_locations::builders::ListLocationsInputBuilder {
        crate::operation::list_locations::builders::ListLocationsInputBuilder::default()
    }
}

/// A builder for [`ListLocationsInput`](crate::operation::list_locations::ListLocationsInput).
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq, std::default::Default, std::fmt::Debug)]
pub struct ListLocationsInputBuilder {
    pub(crate) filters: std::option::Option<std::vec::Vec<crate::types::LocationFilter>>,
    pub(crate) limit: std::option::Option<i32>,
    pub(crate) next_token: std::option::Option<std::string::String>,
}
impl ListLocationsInputBuilder {
    /// Appends an item to `filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>Filters the list for <code>AWS</code> or <code>CUSTOM</code> locations.</p>
    pub fn filters(mut self, input: crate::types::LocationFilter) -> Self {
        let mut v = self.filters.unwrap_or_default();
        v.push(input);
        self.filters = Some(v);
        self
    }
    /// <p>Filters the list for <code>AWS</code> or <code>CUSTOM</code> locations.</p>
    pub fn set_filters(
        mut self,
        input: std::option::Option<std::vec::Vec<crate::types::LocationFilter>>,
    ) -> Self {
        self.filters = input;
        self
    }
    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
    pub fn limit(mut self, input: i32) -> Self {
        self.limit = Some(input);
        self
    }
    /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
    pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
        self.limit = input;
        self
    }
    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
    pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
        self.next_token = Some(input.into());
        self
    }
    /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
    pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// Consumes the builder and constructs a [`ListLocationsInput`](crate::operation::list_locations::ListLocationsInput).
    pub fn build(
        self,
    ) -> Result<
        crate::operation::list_locations::ListLocationsInput,
        aws_smithy_http::operation::error::BuildError,
    > {
        Ok(crate::operation::list_locations::ListLocationsInput {
            filters: self.filters,
            limit: self.limit,
            next_token: self.next_token,
        })
    }
}