// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::search_profiles::_search_profiles_input::SearchProfilesInputBuilder;
pub use crate::operation::search_profiles::_search_profiles_output::SearchProfilesOutputBuilder;
impl crate::operation::search_profiles::builders::SearchProfilesInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::search_profiles::SearchProfilesOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::search_profiles::SearchProfilesError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.search_profiles();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `SearchProfiles`.
///
/// <p>Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a <code>KeyName</code> and <code>Values</code> list.</p>
/// <p>This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either <code>AND</code> or <code>OR</code> logic.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct SearchProfilesFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::search_profiles::builders::SearchProfilesInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::search_profiles::SearchProfilesOutput,
crate::operation::search_profiles::SearchProfilesError,
> for SearchProfilesFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::search_profiles::SearchProfilesOutput,
crate::operation::search_profiles::SearchProfilesError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl SearchProfilesFluentBuilder {
/// Creates a new `SearchProfilesFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the SearchProfiles as a reference.
pub fn as_input(&self) -> &crate::operation::search_profiles::builders::SearchProfilesInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::search_profiles::SearchProfilesOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::search_profiles::SearchProfilesError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::search_profiles::SearchProfiles::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::search_profiles::SearchProfiles::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::search_profiles::SearchProfilesOutput,
crate::operation::search_profiles::SearchProfilesError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The pagination token from the previous SearchProfiles API call.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>The pagination token from the previous SearchProfiles API call.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The pagination token from the previous SearchProfiles API call.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_next_token()
}
/// <p>The maximum number of objects returned per page.</p>
/// <p>The default is 20 if this parameter is not included in the request.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of objects returned per page.</p>
/// <p>The default is 20 if this parameter is not included in the request.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>The maximum number of objects returned per page.</p>
/// <p>The default is 20 if this parameter is not included in the request.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
self.inner.get_max_results()
}
/// <p>The unique name of the domain.</p>
pub fn domain_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.domain_name(input.into());
self
}
/// <p>The unique name of the domain.</p>
pub fn set_domain_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_domain_name(input);
self
}
/// <p>The unique name of the domain.</p>
pub fn get_domain_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_domain_name()
}
/// <p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>
pub fn key_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.key_name(input.into());
self
}
/// <p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>
pub fn set_key_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_key_name(input);
self
}
/// <p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>
pub fn get_key_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_key_name()
}
///
/// Appends an item to `Values`.
///
/// To override the contents of this collection use [`set_values`](Self::set_values).
///
/// <p>A list of key values.</p>
pub fn values(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.values(input.into());
self
}
/// <p>A list of key values.</p>
pub fn set_values(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_values(input);
self
}
/// <p>A list of key values.</p>
pub fn get_values(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_values()
}
///
/// Appends an item to `AdditionalSearchKeys`.
///
/// To override the contents of this collection use [`set_additional_search_keys`](Self::set_additional_search_keys).
///
/// <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers of a profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code> and a list of <code>Values</code> associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the <code>LogicalOperator</code> and the required <code>KeyName</code> and <code>Values</code> parameters to search for profiles that satisfy the search criteria.</p>
pub fn additional_search_keys(mut self, input: crate::types::AdditionalSearchKey) -> Self {
self.inner = self.inner.additional_search_keys(input);
self
}
/// <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers of a profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code> and a list of <code>Values</code> associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the <code>LogicalOperator</code> and the required <code>KeyName</code> and <code>Values</code> parameters to search for profiles that satisfy the search criteria.</p>
pub fn set_additional_search_keys(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AdditionalSearchKey>>) -> Self {
self.inner = self.inner.set_additional_search_keys(input);
self
}
/// <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers of a profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code> and a list of <code>Values</code> associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the <code>LogicalOperator</code> and the required <code>KeyName</code> and <code>Values</code> parameters to search for profiles that satisfy the search criteria.</p>
pub fn get_additional_search_keys(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AdditionalSearchKey>> {
self.inner.get_additional_search_keys()
}
/// <p>Relationship between all specified search keys that will be used to search for profiles. This includes the required <code>KeyName</code> and <code>Values</code> parameters as well as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
/// <p>This parameter influences which profiles will be returned in the response in the following manner:</p>
/// <ul>
/// <li>
/// <p><code>AND</code> - The response only includes profiles that match all of the search keys.</p></li>
/// <li>
/// <p><code>OR</code> - The response includes profiles that match at least one of the search keys.</p></li>
/// </ul>
/// <p>The <code>OR</code> relationship is the default behavior if this parameter is not included in the request.</p>
pub fn logical_operator(mut self, input: crate::types::LogicalOperator) -> Self {
self.inner = self.inner.logical_operator(input);
self
}
/// <p>Relationship between all specified search keys that will be used to search for profiles. This includes the required <code>KeyName</code> and <code>Values</code> parameters as well as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
/// <p>This parameter influences which profiles will be returned in the response in the following manner:</p>
/// <ul>
/// <li>
/// <p><code>AND</code> - The response only includes profiles that match all of the search keys.</p></li>
/// <li>
/// <p><code>OR</code> - The response includes profiles that match at least one of the search keys.</p></li>
/// </ul>
/// <p>The <code>OR</code> relationship is the default behavior if this parameter is not included in the request.</p>
pub fn set_logical_operator(mut self, input: ::std::option::Option<crate::types::LogicalOperator>) -> Self {
self.inner = self.inner.set_logical_operator(input);
self
}
/// <p>Relationship between all specified search keys that will be used to search for profiles. This includes the required <code>KeyName</code> and <code>Values</code> parameters as well as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
/// <p>This parameter influences which profiles will be returned in the response in the following manner:</p>
/// <ul>
/// <li>
/// <p><code>AND</code> - The response only includes profiles that match all of the search keys.</p></li>
/// <li>
/// <p><code>OR</code> - The response includes profiles that match at least one of the search keys.</p></li>
/// </ul>
/// <p>The <code>OR</code> relationship is the default behavior if this parameter is not included in the request.</p>
pub fn get_logical_operator(&self) -> &::std::option::Option<crate::types::LogicalOperator> {
self.inner.get_logical_operator()
}
}