aws-sdk-sagemaker 1.193.0

AWS SDK for Amazon SageMaker Service
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 ListSpacesInput {
    /// <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>This parameter defines the maximum number of results that can be return in a single response. The <code>MaxResults</code> parameter is an upper bound, not a target. If there are more results available than the value specified, a <code>NextToken</code> is provided in the response. The <code>NextToken</code> indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for <code>MaxResults</code> is 10.</p>
    pub max_results: ::std::option::Option<i32>,
    /// <p>The sort order for the results. The default is <code>Ascending</code>.</p>
    pub sort_order: ::std::option::Option<crate::types::SortOrder>,
    /// <p>The parameter by which to sort the results. The default is <code>CreationTime</code>.</p>
    pub sort_by: ::std::option::Option<crate::types::SpaceSortKey>,
    /// <p>A parameter to search for the domain ID.</p>
    pub domain_id_equals: ::std::option::Option<::std::string::String>,
    /// <p>A parameter by which to filter the results.</p>
    pub space_name_contains: ::std::option::Option<::std::string::String>,
}
impl ListSpacesInput {
    /// <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>This parameter defines the maximum number of results that can be return in a single response. The <code>MaxResults</code> parameter is an upper bound, not a target. If there are more results available than the value specified, a <code>NextToken</code> is provided in the response. The <code>NextToken</code> indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for <code>MaxResults</code> is 10.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
    /// <p>The sort order for the results. The default is <code>Ascending</code>.</p>
    pub fn sort_order(&self) -> ::std::option::Option<&crate::types::SortOrder> {
        self.sort_order.as_ref()
    }
    /// <p>The parameter by which to sort the results. The default is <code>CreationTime</code>.</p>
    pub fn sort_by(&self) -> ::std::option::Option<&crate::types::SpaceSortKey> {
        self.sort_by.as_ref()
    }
    /// <p>A parameter to search for the domain ID.</p>
    pub fn domain_id_equals(&self) -> ::std::option::Option<&str> {
        self.domain_id_equals.as_deref()
    }
    /// <p>A parameter by which to filter the results.</p>
    pub fn space_name_contains(&self) -> ::std::option::Option<&str> {
        self.space_name_contains.as_deref()
    }
}
impl ListSpacesInput {
    /// Creates a new builder-style object to manufacture [`ListSpacesInput`](crate::operation::list_spaces::ListSpacesInput).
    pub fn builder() -> crate::operation::list_spaces::builders::ListSpacesInputBuilder {
        crate::operation::list_spaces::builders::ListSpacesInputBuilder::default()
    }
}

/// A builder for [`ListSpacesInput`](crate::operation::list_spaces::ListSpacesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListSpacesInputBuilder {
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) max_results: ::std::option::Option<i32>,
    pub(crate) sort_order: ::std::option::Option<crate::types::SortOrder>,
    pub(crate) sort_by: ::std::option::Option<crate::types::SpaceSortKey>,
    pub(crate) domain_id_equals: ::std::option::Option<::std::string::String>,
    pub(crate) space_name_contains: ::std::option::Option<::std::string::String>,
}
impl ListSpacesInputBuilder {
    /// <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</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>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// <p>This parameter defines the maximum number of results that can be return in a single response. The <code>MaxResults</code> parameter is an upper bound, not a target. If there are more results available than the value specified, a <code>NextToken</code> is provided in the response. The <code>NextToken</code> indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for <code>MaxResults</code> is 10.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.max_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>This parameter defines the maximum number of results that can be return in a single response. The <code>MaxResults</code> parameter is an upper bound, not a target. If there are more results available than the value specified, a <code>NextToken</code> is provided in the response. The <code>NextToken</code> indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for <code>MaxResults</code> is 10.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.max_results = input;
        self
    }
    /// <p>This parameter defines the maximum number of results that can be return in a single response. The <code>MaxResults</code> parameter is an upper bound, not a target. If there are more results available than the value specified, a <code>NextToken</code> is provided in the response. The <code>NextToken</code> indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for <code>MaxResults</code> is 10.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// <p>The sort order for the results. The default is <code>Ascending</code>.</p>
    pub fn sort_order(mut self, input: crate::types::SortOrder) -> Self {
        self.sort_order = ::std::option::Option::Some(input);
        self
    }
    /// <p>The sort order for the results. The default is <code>Ascending</code>.</p>
    pub fn set_sort_order(mut self, input: ::std::option::Option<crate::types::SortOrder>) -> Self {
        self.sort_order = input;
        self
    }
    /// <p>The sort order for the results. The default is <code>Ascending</code>.</p>
    pub fn get_sort_order(&self) -> &::std::option::Option<crate::types::SortOrder> {
        &self.sort_order
    }
    /// <p>The parameter by which to sort the results. The default is <code>CreationTime</code>.</p>
    pub fn sort_by(mut self, input: crate::types::SpaceSortKey) -> Self {
        self.sort_by = ::std::option::Option::Some(input);
        self
    }
    /// <p>The parameter by which to sort the results. The default is <code>CreationTime</code>.</p>
    pub fn set_sort_by(mut self, input: ::std::option::Option<crate::types::SpaceSortKey>) -> Self {
        self.sort_by = input;
        self
    }
    /// <p>The parameter by which to sort the results. The default is <code>CreationTime</code>.</p>
    pub fn get_sort_by(&self) -> &::std::option::Option<crate::types::SpaceSortKey> {
        &self.sort_by
    }
    /// <p>A parameter to search for the domain ID.</p>
    pub fn domain_id_equals(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.domain_id_equals = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A parameter to search for the domain ID.</p>
    pub fn set_domain_id_equals(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.domain_id_equals = input;
        self
    }
    /// <p>A parameter to search for the domain ID.</p>
    pub fn get_domain_id_equals(&self) -> &::std::option::Option<::std::string::String> {
        &self.domain_id_equals
    }
    /// <p>A parameter by which to filter the results.</p>
    pub fn space_name_contains(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.space_name_contains = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A parameter by which to filter the results.</p>
    pub fn set_space_name_contains(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.space_name_contains = input;
        self
    }
    /// <p>A parameter by which to filter the results.</p>
    pub fn get_space_name_contains(&self) -> &::std::option::Option<::std::string::String> {
        &self.space_name_contains
    }
    /// Consumes the builder and constructs a [`ListSpacesInput`](crate::operation::list_spaces::ListSpacesInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::list_spaces::ListSpacesInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::list_spaces::ListSpacesInput {
            next_token: self.next_token,
            max_results: self.max_results,
            sort_order: self.sort_order,
            sort_by: self.sort_by,
            domain_id_equals: self.domain_id_equals,
            space_name_contains: self.space_name_contains,
        })
    }
}