aws-sdk-datazone 1.136.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)]
pub struct SearchUserProfilesInput {
    /// <p>The identifier of the Amazon DataZone domain in which you want to search user profiles.</p>
    pub domain_identifier: ::std::option::Option<::std::string::String>,
    /// <p>Specifies the user type for the <code>SearchUserProfiles</code> action.</p>
    pub user_type: ::std::option::Option<crate::types::UserSearchType>,
    /// <p>Specifies the text for which to search.</p>
    pub search_text: ::std::option::Option<::std::string::String>,
    /// <p>The maximum number of results to return in a single call to <code>SearchUserProfiles</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.</p>
    pub max_results: ::std::option::Option<i32>,
    /// <p>When the number of results 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 results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
}
impl SearchUserProfilesInput {
    /// <p>The identifier of the Amazon DataZone domain in which you want to search user profiles.</p>
    pub fn domain_identifier(&self) -> ::std::option::Option<&str> {
        self.domain_identifier.as_deref()
    }
    /// <p>Specifies the user type for the <code>SearchUserProfiles</code> action.</p>
    pub fn user_type(&self) -> ::std::option::Option<&crate::types::UserSearchType> {
        self.user_type.as_ref()
    }
    /// <p>Specifies the text for which to search.</p>
    pub fn search_text(&self) -> ::std::option::Option<&str> {
        self.search_text.as_deref()
    }
    /// <p>The maximum number of results to return in a single call to <code>SearchUserProfiles</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
    /// <p>When the number of results 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 results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
}
impl ::std::fmt::Debug for SearchUserProfilesInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("SearchUserProfilesInput");
        formatter.field("domain_identifier", &self.domain_identifier);
        formatter.field("user_type", &self.user_type);
        formatter.field("search_text", &"*** Sensitive Data Redacted ***");
        formatter.field("max_results", &self.max_results);
        formatter.field("next_token", &self.next_token);
        formatter.finish()
    }
}
impl SearchUserProfilesInput {
    /// Creates a new builder-style object to manufacture [`SearchUserProfilesInput`](crate::operation::search_user_profiles::SearchUserProfilesInput).
    pub fn builder() -> crate::operation::search_user_profiles::builders::SearchUserProfilesInputBuilder {
        crate::operation::search_user_profiles::builders::SearchUserProfilesInputBuilder::default()
    }
}

/// A builder for [`SearchUserProfilesInput`](crate::operation::search_user_profiles::SearchUserProfilesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct SearchUserProfilesInputBuilder {
    pub(crate) domain_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) user_type: ::std::option::Option<crate::types::UserSearchType>,
    pub(crate) search_text: ::std::option::Option<::std::string::String>,
    pub(crate) max_results: ::std::option::Option<i32>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
}
impl SearchUserProfilesInputBuilder {
    /// <p>The identifier of the Amazon DataZone domain in which you want to search user profiles.</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 DataZone domain in which you want to search user profiles.</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 DataZone domain in which you want to search user profiles.</p>
    pub fn get_domain_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.domain_identifier
    }
    /// <p>Specifies the user type for the <code>SearchUserProfiles</code> action.</p>
    /// This field is required.
    pub fn user_type(mut self, input: crate::types::UserSearchType) -> Self {
        self.user_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies the user type for the <code>SearchUserProfiles</code> action.</p>
    pub fn set_user_type(mut self, input: ::std::option::Option<crate::types::UserSearchType>) -> Self {
        self.user_type = input;
        self
    }
    /// <p>Specifies the user type for the <code>SearchUserProfiles</code> action.</p>
    pub fn get_user_type(&self) -> &::std::option::Option<crate::types::UserSearchType> {
        &self.user_type
    }
    /// <p>Specifies the text for which to search.</p>
    pub fn search_text(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.search_text = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Specifies the text for which to search.</p>
    pub fn set_search_text(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.search_text = input;
        self
    }
    /// <p>Specifies the text for which to search.</p>
    pub fn get_search_text(&self) -> &::std::option::Option<::std::string::String> {
        &self.search_text
    }
    /// <p>The maximum number of results to return in a single call to <code>SearchUserProfiles</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchUserProfiles</code> to list 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 results to return in a single call to <code>SearchUserProfiles</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchUserProfiles</code> to list 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 results to return in a single call to <code>SearchUserProfiles</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// <p>When the number of results 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 results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchUserProfiles</code> to list 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>When the number of results 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 results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchUserProfiles</code> to list 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>When the number of results 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 results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// Consumes the builder and constructs a [`SearchUserProfilesInput`](crate::operation::search_user_profiles::SearchUserProfilesInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::search_user_profiles::SearchUserProfilesInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::search_user_profiles::SearchUserProfilesInput {
            domain_identifier: self.domain_identifier,
            user_type: self.user_type,
            search_text: self.search_text,
            max_results: self.max_results,
            next_token: self.next_token,
        })
    }
}
impl ::std::fmt::Debug for SearchUserProfilesInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("SearchUserProfilesInputBuilder");
        formatter.field("domain_identifier", &self.domain_identifier);
        formatter.field("user_type", &self.user_type);
        formatter.field("search_text", &"*** Sensitive Data Redacted ***");
        formatter.field("max_results", &self.max_results);
        formatter.field("next_token", &self.next_token);
        formatter.finish()
    }
}