Struct SearchProfilesInput

#[non_exhaustive]
pub struct SearchProfilesInput {
    pub next_token: Option<String>,
    pub max_results: Option<i32>,
    pub domain_name: Option<String>,
    pub key_name: Option<String>,
    pub values: Option<Vec<String>>,
    pub additional_search_keys: Option<Vec<AdditionalSearchKey>>,
    pub logical_operator: Option<LogicalOperator>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

next_token: Option<String>

The pagination token from the previous SearchProfiles API call.

max_results: Option<i32>

The maximum number of objects returned per page.

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

domain_name: Option<String>

The unique name of the domain.

key_name: 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.

values: Option<Vec<String>>

A list of key values.

additional_search_keys: 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.

logical_operator: 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.

Implementations

impl SearchProfilesInput

pub fn next_token(&self) -> Option<&str>

The pagination token from the previous SearchProfiles API call.

pub fn 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) -> Option<&str>

The unique name of the domain.

pub fn key_name(&self) -> Option<&str>

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) -> &[String]

A list of key values.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .values.is_none().

pub fn additional_search_keys(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_search_keys.is_none().

pub fn 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.

impl SearchProfilesInput

pub fn builder() -> SearchProfilesInputBuilder

Creates a new builder-style object to manufacture SearchProfilesInput.

Trait Implementations

impl Clone for SearchProfilesInput

fn clone(&self) -> SearchProfilesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchProfilesInput

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

Formats the value using the given formatter.

impl PartialEq for SearchProfilesInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SearchProfilesInput