Class SearchProfilesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesRequest
software.amazon.awssdk.services.customerprofiles.model.SearchProfilesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>
@Generated("software.amazon.awssdk:codegen") public final class SearchProfilesRequest extends CustomerProfilesRequest implements ToCopyableBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>

  • Method Details

    • nextToken

      public final String nextToken()

      The pagination token from the previous SearchProfiles API call.

      Returns:
      The pagination token from the previous SearchProfiles API call.

    • maxResults

      public final Integer maxResults()

      The maximum number of objects returned per page.

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

      Returns:
      The maximum number of objects returned per page.

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

    • domainName

      public final String domainName()

      The unique name of the domain.

      Returns:
      The unique name of the domain.

    • keyName

      public final 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.

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

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • values

      public final List<String> values()

      A list of key values.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

      Returns:
      A list of key values.

    • hasAdditionalSearchKeys

      public final boolean hasAdditionalSearchKeys()
      For responses, this returns true if the service returned a value for the AdditionalSearchKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • additionalSearchKeys

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalSearchKeys() method.

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

    • logicalOperator

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, logicalOperator will return LogicalOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logicalOperatorAsString().

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

      See Also:

    • logicalOperatorAsString

      public final String logicalOperatorAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, logicalOperator will return LogicalOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logicalOperatorAsString().

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

      See Also:

    • toBuilder

      public SearchProfilesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>
      Specified by:
      toBuilder in class CustomerProfilesRequest
      Returns:
      a builder for type T

    • builder

      public static SearchProfilesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchProfilesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.