aws-sdk-datazone 1.137.0

AWS SDK for Amazon DataZone
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 ListNotebooksInput {
    /// <p>The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.</p>
    pub domain_identifier: ::std::option::Option<::std::string::String>,
    /// <p>The identifier of the project that owns the notebooks.</p>
    pub owning_project_identifier: ::std::option::Option<::std::string::String>,
    /// <p>The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value.</p>
    pub max_results: ::std::option::Option<i32>,
    /// <p>The sort order for the results.</p>
    pub sort_order: ::std::option::Option<crate::types::SortOrder>,
    /// <p>The field to sort the results by.</p>
    pub sort_by: ::std::option::Option<crate::types::SortKey>,
    /// <p>The status to filter notebooks by.</p>
    pub status: ::std::option::Option<crate::types::NotebookStatus>,
    /// <p>When the number of notebooks is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of notebooks, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebooks</code> to list the next set of notebooks.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
}
impl ListNotebooksInput {
    /// <p>The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.</p>
    pub fn domain_identifier(&self) -> ::std::option::Option<&str> {
        self.domain_identifier.as_deref()
    }
    /// <p>The identifier of the project that owns the notebooks.</p>
    pub fn owning_project_identifier(&self) -> ::std::option::Option<&str> {
        self.owning_project_identifier.as_deref()
    }
    /// <p>The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
    /// <p>The sort order for the results.</p>
    pub fn sort_order(&self) -> ::std::option::Option<&crate::types::SortOrder> {
        self.sort_order.as_ref()
    }
    /// <p>The field to sort the results by.</p>
    pub fn sort_by(&self) -> ::std::option::Option<&crate::types::SortKey> {
        self.sort_by.as_ref()
    }
    /// <p>The status to filter notebooks by.</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::NotebookStatus> {
        self.status.as_ref()
    }
    /// <p>When the number of notebooks is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of notebooks, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebooks</code> to list the next set of notebooks.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
}
impl ListNotebooksInput {
    /// Creates a new builder-style object to manufacture [`ListNotebooksInput`](crate::operation::list_notebooks::ListNotebooksInput).
    pub fn builder() -> crate::operation::list_notebooks::builders::ListNotebooksInputBuilder {
        crate::operation::list_notebooks::builders::ListNotebooksInputBuilder::default()
    }
}

/// A builder for [`ListNotebooksInput`](crate::operation::list_notebooks::ListNotebooksInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListNotebooksInputBuilder {
    pub(crate) domain_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) owning_project_identifier: ::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::SortKey>,
    pub(crate) status: ::std::option::Option<crate::types::NotebookStatus>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
}
impl ListNotebooksInputBuilder {
    /// <p>The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.</p>
    /// This field is required.
    pub fn domain_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.domain_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.</p>
    pub fn set_domain_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.domain_identifier = input;
        self
    }
    /// <p>The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.</p>
    pub fn get_domain_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.domain_identifier
    }
    /// <p>The identifier of the project that owns the notebooks.</p>
    /// This field is required.
    pub fn owning_project_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.owning_project_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the project that owns the notebooks.</p>
    pub fn set_owning_project_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.owning_project_identifier = input;
        self
    }
    /// <p>The identifier of the project that owns the notebooks.</p>
    pub fn get_owning_project_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.owning_project_identifier
    }
    /// <p>The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.max_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.max_results = input;
        self
    }
    /// <p>The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// <p>The sort order for the results.</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.</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.</p>
    pub fn get_sort_order(&self) -> &::std::option::Option<crate::types::SortOrder> {
        &self.sort_order
    }
    /// <p>The field to sort the results by.</p>
    pub fn sort_by(mut self, input: crate::types::SortKey) -> Self {
        self.sort_by = ::std::option::Option::Some(input);
        self
    }
    /// <p>The field to sort the results by.</p>
    pub fn set_sort_by(mut self, input: ::std::option::Option<crate::types::SortKey>) -> Self {
        self.sort_by = input;
        self
    }
    /// <p>The field to sort the results by.</p>
    pub fn get_sort_by(&self) -> &::std::option::Option<crate::types::SortKey> {
        &self.sort_by
    }
    /// <p>The status to filter notebooks by.</p>
    pub fn status(mut self, input: crate::types::NotebookStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status to filter notebooks by.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::NotebookStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status to filter notebooks by.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::NotebookStatus> {
        &self.status
    }
    /// <p>When the number of notebooks is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of notebooks, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebooks</code> to list the next set of notebooks.</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>When the number of notebooks is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of notebooks, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebooks</code> to list the next set of notebooks.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>When the number of notebooks is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of notebooks, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebooks</code> to list the next set of notebooks.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// Consumes the builder and constructs a [`ListNotebooksInput`](crate::operation::list_notebooks::ListNotebooksInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::list_notebooks::ListNotebooksInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::list_notebooks::ListNotebooksInput {
            domain_identifier: self.domain_identifier,
            owning_project_identifier: self.owning_project_identifier,
            max_results: self.max_results,
            sort_order: self.sort_order,
            sort_by: self.sort_by,
            status: self.status,
            next_token: self.next_token,
        })
    }
}