Package software.amazon.awssdk.services.customerprofiles.model

Class GetSimilarProfilesResponse

    • Method Detail

      • hasProfileIds

        public final boolean hasProfileIds()
        For responses, this returns true if the service returned a value for the ProfileIds 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.

      • profileIds

        public final List<String> profileIds()

        Set of profileIds that belong to the same matching group.

        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 hasProfileIds() method.

        Returns:
        Set of profileIds that belong to the same matching group.

      • matchId

        public final String matchId()

        The string matchId that the similar profiles belong to.

        Returns:
        The string matchId that the similar profiles belong to.

      • matchType

        public final MatchType matchType()

        Specify the type of matching to get similar profiles for.

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

        Returns:
        Specify the type of matching to get similar profiles for.
        See Also:
        MatchType

      • matchTypeAsString

        public final String matchTypeAsString()

        Specify the type of matching to get similar profiles for.

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

        Returns:
        Specify the type of matching to get similar profiles for.
        See Also:
        MatchType

      • ruleLevel

        public final Integer ruleLevel()

        The integer rule level that the profiles matched on.

        Returns:
        The integer rule level that the profiles matched on.

      • confidenceScore

        public final Double confidenceScore()

        It only has value when the MatchType is ML_BASED_MATCHING.A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used as an absolute measure of matching quality.

        Returns:
        It only has value when the MatchType is ML_BASED_MATCHING.A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used as an absolute measure of matching quality.

      • nextToken

        public final String nextToken()

        The pagination token from the previous GetSimilarProfiles API call.

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

      • 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