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

Interface GetSimilarProfilesResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetSimilarProfilesResponse.Builder,GetSimilarProfilesResponse>, CustomerProfilesResponse.Builder, SdkBuilder<GetSimilarProfilesResponse.Builder,GetSimilarProfilesResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetSimilarProfilesResponse

public static interface GetSimilarProfilesResponse.Builder
extends CustomerProfilesResponse.Builder, SdkPojo, CopyableBuilder<GetSimilarProfilesResponse.Builder,GetSimilarProfilesResponse>

Method Summary

Modifier and Type	Method	Description
GetSimilarProfilesResponse.Builder	confidenceScore(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.
GetSimilarProfilesResponse.Builder	matchId(String matchId)	The string matchId that the similar profiles belong to.
GetSimilarProfilesResponse.Builder	matchType(String matchType)	Specify the type of matching to get similar profiles for.
GetSimilarProfilesResponse.Builder	matchType(MatchType matchType)	Specify the type of matching to get similar profiles for.
GetSimilarProfilesResponse.Builder	nextToken(String nextToken)	The pagination token from the previous GetSimilarProfiles API call.
GetSimilarProfilesResponse.Builder	profileIds(String... profileIds)	Set of profileIds that belong to the same matching group.
GetSimilarProfilesResponse.Builder	profileIds(Collection<String> profileIds)	Set of profileIds that belong to the same matching group.
GetSimilarProfilesResponse.Builder	ruleLevel(Integer ruleLevel)	The integer rule level that the profiles matched on.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

profileIds

GetSimilarProfilesResponse.Builder profileIds(Collection<String> profileIds)

Set of profileIds that belong to the same matching group.

Parameters:

profileIds - Set of profileIds that belong to the same matching group.

Returns:

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

profileIds

GetSimilarProfilesResponse.Builder profileIds(String... profileIds)

Set of profileIds that belong to the same matching group.

Parameters:

profileIds - Set of profileIds that belong to the same matching group.

Returns:

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

matchId

GetSimilarProfilesResponse.Builder matchId(String matchId)

The string matchId that the similar profiles belong to.

Parameters:

matchId - The string matchId that the similar profiles belong to.

Returns:

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

matchType

GetSimilarProfilesResponse.Builder matchType(String matchType)

Specify the type of matching to get similar profiles for.

Parameters:

matchType - Specify the type of matching to get similar profiles for.

Returns:

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

See Also:

MatchType, MatchType

matchType

GetSimilarProfilesResponse.Builder matchType(MatchType matchType)

Specify the type of matching to get similar profiles for.

Parameters:

matchType - Specify the type of matching to get similar profiles for.

Returns:

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

See Also:

MatchType, MatchType

ruleLevel

GetSimilarProfilesResponse.Builder ruleLevel(Integer ruleLevel)

The integer rule level that the profiles matched on.

Parameters:

ruleLevel - The integer rule level that the profiles matched on.

Returns:

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

confidenceScore

GetSimilarProfilesResponse.Builder confidenceScore(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.

Parameters:

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:

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

nextToken

GetSimilarProfilesResponse.Builder nextToken(String nextToken)

The pagination token from the previous GetSimilarProfiles API call.

Parameters:

nextToken - The pagination token from the previous GetSimilarProfiles API call.

Returns:

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