software.amazon.awssdk.services.customerprofiles.model

Class GetSimilarProfilesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse

software.amazon.awssdk.services.customerprofiles.model.GetSimilarProfilesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSimilarProfilesResponse.Builder,GetSimilarProfilesResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetSimilarProfilesResponse
extends CustomerProfilesResponse
implements ToCopyableBuilder<GetSimilarProfilesResponse.Builder,GetSimilarProfilesResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSimilarProfilesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetSimilarProfilesResponse.Builder	builder()
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProfileIds() For responses, this returns true if the service returned a value for the ProfileIds property.
String	matchId() The string matchId that the similar profiles belong to.
MatchType	matchType() Specify the type of matching to get similar profiles for.
String	matchTypeAsString() Specify the type of matching to get similar profiles for.
String	nextToken() The pagination token from the previous GetSimilarProfiles API call.
List<String>	profileIds() Set of profileIds that belong to the same matching group.
Integer	ruleLevel() The integer rule level that the profiles matched on.
List<SdkField<?>>	sdkFields()
static Class<? extends GetSimilarProfilesResponse.Builder>	serializableBuilderClass()
GetSimilarProfilesResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

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.

toBuilder

public GetSimilarProfilesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSimilarProfilesResponse.Builder,GetSimilarProfilesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetSimilarProfilesResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo