Interface SearchProfilesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SearchProfilesRequest.Builder,
,SearchProfilesRequest> CustomerProfilesRequest.Builder
,SdkBuilder<SearchProfilesRequest.Builder,
,SearchProfilesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchProfilesRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalSearchKeys
(Collection<AdditionalSearchKey> additionalSearchKeys) A list ofAdditionalSearchKey
objects that are each searchable identifiers of a profile.additionalSearchKeys
(Consumer<AdditionalSearchKey.Builder>... additionalSearchKeys) A list ofAdditionalSearchKey
objects that are each searchable identifiers of a profile.additionalSearchKeys
(AdditionalSearchKey... additionalSearchKeys) A list ofAdditionalSearchKey
objects that are each searchable identifiers of a profile.domainName
(String domainName) The unique name of the domain.A searchable identifier of a customer profile.logicalOperator
(String logicalOperator) Relationship between all specified search keys that will be used to search for profiles.logicalOperator
(LogicalOperator logicalOperator) Relationship between all specified search keys that will be used to search for profiles.maxResults
(Integer maxResults) The maximum number of objects returned per page.The pagination token from the previous SearchProfiles API call.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.A list of key values.values
(Collection<String> values) A list of key values.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
nextToken
The pagination token from the previous SearchProfiles API call.
- Parameters:
nextToken
- The pagination token from the previous SearchProfiles API call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of objects returned per page.
The default is 20 if this parameter is not included in the request.
- Parameters:
maxResults
- The maximum number of objects returned per page.The default is 20 if this parameter is not included in the request.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainName
The unique name of the domain.
- Parameters:
domainName
- The unique name of the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyName
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.
- Parameters:
keyName
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
values
A list of key values.
- Parameters:
values
- A list of key values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
values
A list of key values.
- Parameters:
values
- A list of key values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalSearchKeys
SearchProfilesRequest.Builder additionalSearchKeys(Collection<AdditionalSearchKey> additionalSearchKeys) A list of
AdditionalSearchKey
objects that are each searchable identifiers of a profile. EachAdditionalSearchKey
object contains aKeyName
and a list ofValues
associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with theLogicalOperator
and the requiredKeyName
andValues
parameters to search for profiles that satisfy the search criteria.- Parameters:
additionalSearchKeys
- A list ofAdditionalSearchKey
objects that are each searchable identifiers of a profile. EachAdditionalSearchKey
object contains aKeyName
and a list ofValues
associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with theLogicalOperator
and the requiredKeyName
andValues
parameters to search for profiles that satisfy the search criteria.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalSearchKeys
A list of
AdditionalSearchKey
objects that are each searchable identifiers of a profile. EachAdditionalSearchKey
object contains aKeyName
and a list ofValues
associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with theLogicalOperator
and the requiredKeyName
andValues
parameters to search for profiles that satisfy the search criteria.- Parameters:
additionalSearchKeys
- A list ofAdditionalSearchKey
objects that are each searchable identifiers of a profile. EachAdditionalSearchKey
object contains aKeyName
and a list ofValues
associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with theLogicalOperator
and the requiredKeyName
andValues
parameters to search for profiles that satisfy the search criteria.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalSearchKeys
SearchProfilesRequest.Builder additionalSearchKeys(Consumer<AdditionalSearchKey.Builder>... additionalSearchKeys) A list of
This is a convenience method that creates an instance of theAdditionalSearchKey
objects that are each searchable identifiers of a profile. EachAdditionalSearchKey
object contains aKeyName
and a list ofValues
associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with theLogicalOperator
and the requiredKeyName
andValues
parameters to search for profiles that satisfy the search criteria.AdditionalSearchKey.Builder
avoiding the need to create one manually viaAdditionalSearchKey.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadditionalSearchKeys(List<AdditionalSearchKey>)
.- Parameters:
additionalSearchKeys
- a consumer that will call methods onAdditionalSearchKey.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
logicalOperator
Relationship between all specified search keys that will be used to search for profiles. This includes the required
KeyName
andValues
parameters as well as any key-value(s) pairs specified in theAdditionalSearchKeys
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.- Parameters:
logicalOperator
- Relationship between all specified search keys that will be used to search for profiles. This includes the requiredKeyName
andValues
parameters as well as any key-value(s) pairs specified in theAdditionalSearchKeys
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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
logicalOperator
Relationship between all specified search keys that will be used to search for profiles. This includes the required
KeyName
andValues
parameters as well as any key-value(s) pairs specified in theAdditionalSearchKeys
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.- Parameters:
logicalOperator
- Relationship between all specified search keys that will be used to search for profiles. This includes the requiredKeyName
andValues
parameters as well as any key-value(s) pairs specified in theAdditionalSearchKeys
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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
overrideConfiguration
SearchProfilesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SearchProfilesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-