Interface SearchProfilesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>, CustomerProfilesRequest.Builder, SdkBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchProfilesRequest
@Mutable @NotThreadSafe public static interface SearchProfilesRequest.Builder extends CustomerProfilesRequest.Builder, SdkPojo, CopyableBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>

  • Method Details

    • nextToken

      SearchProfilesRequest.Builder nextToken(String 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

      SearchProfilesRequest.Builder maxResults(Integer 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

      SearchProfilesRequest.Builder domainName(String 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

      SearchProfilesRequest.Builder keyName(String 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

      SearchProfilesRequest.Builder values(Collection<String> 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

      SearchProfilesRequest.Builder values(String... 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. 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.

      Parameters:
      additionalSearchKeys - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalSearchKeys

      SearchProfilesRequest.Builder additionalSearchKeys(AdditionalSearchKey... additionalSearchKeys)

      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.

      Parameters:
      additionalSearchKeys - 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.
      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 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.

      This is a convenience method that creates an instance of the AdditionalSearchKey.Builder avoiding the need to create one manually via AdditionalSearchKey.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to additionalSearchKeys(List<AdditionalSearchKey>).

      Parameters:
      additionalSearchKeys - a consumer that will call methods on AdditionalSearchKey.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logicalOperator

      SearchProfilesRequest.Builder logicalOperator(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logicalOperator

      SearchProfilesRequest.Builder logicalOperator(LogicalOperator 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.

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

      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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.