Struct aws_sdk_customerprofiles::operation::search_profiles::builders::SearchProfilesInputBuilder

#[non_exhaustive]
pub struct SearchProfilesInputBuilder { /* private fields */ }

A builder for SearchProfilesInput.

Implementations

impl SearchProfilesInputBuilder

pub fn next_token(self, input: impl Into<String>) -> Self

The pagination token from the previous SearchProfiles API call.

pub fn set_next_token(self, input: Option<String>) -> Self

The pagination token from the previous SearchProfiles API call.

pub fn get_next_token(&self) -> &Option<String>

The pagination token from the previous SearchProfiles API call.

pub fn max_results(self, input: i32) -> Self

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

pub fn get_max_results(&self) -> &Option<i32>

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

pub fn domain_name(self, input: impl Into<String>) -> Self

The unique name of the domain.

This field is required.

pub fn set_domain_name(self, input: Option<String>) -> Self

The unique name of the domain.

pub fn get_domain_name(&self) -> &Option<String>

The unique name of the domain.

pub fn key_name(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_key_name(self, input: Option<String>) -> Self

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.

pub fn get_key_name(&self) -> &Option<String>

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.

pub fn values(self, input: impl Into<String>) -> Self

Appends an item to values.

To override the contents of this collection use set_values.

A list of key values.

pub fn set_values(self, input: Option<Vec<String>>) -> Self

A list of key values.

pub fn get_values(&self) -> &Option<Vec<String>>

A list of key values.

pub fn additional_search_keys(self, input: AdditionalSearchKey) -> Self

Appends an item to additional_search_keys.

To override the contents of this collection use set_additional_search_keys.

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

pub fn set_additional_search_keys( self, input: Option<Vec<AdditionalSearchKey>> ) -> Self

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

pub fn get_additional_search_keys(&self) -> &Option<Vec<AdditionalSearchKey>>

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

pub fn logical_operator(self, input: LogicalOperator) -> Self

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

pub fn set_logical_operator(self, input: Option<LogicalOperator>) -> Self

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

pub fn get_logical_operator(&self) -> &Option<LogicalOperator>

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

pub fn build(self) -> Result<SearchProfilesInput, BuildError>

Consumes the builder and constructs a SearchProfilesInput.

impl SearchProfilesInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<SearchProfilesOutput, SdkError<SearchProfilesError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for SearchProfilesInputBuilder

fn clone(&self) -> SearchProfilesInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchProfilesInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchProfilesInputBuilder

fn default() -> SearchProfilesInputBuilder

Returns the “default value” for a type.

impl PartialEq for SearchProfilesInputBuilder

fn eq(&self, other: &SearchProfilesInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SearchProfilesInputBuilder