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

Class MatchItem

java.lang.Object

software.amazon.awssdk.services.customerprofiles.model.MatchItem

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MatchItem.Builder,MatchItem>

@Generated("software.amazon.awssdk:codegen")
public final class MatchItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MatchItem.Builder,MatchItem>

The Match group object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MatchItem.Builder

Method Summary

Modifier and Type	Method	Description
static MatchItem.Builder	builder()
Double	confidenceScore()	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 unique identifiers for this group of profiles that match.
List<String>	profileIds()	A list of identifiers for profiles that match.
List<SdkField<?>>	sdkFields()
static Class<? extends MatchItem.Builder>	serializableBuilderClass()
MatchItem.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

matchId

public final String matchId()

The unique identifiers for this group of profiles that match.

Returns:

The unique identifiers for this group of profiles that match.

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()

A list of identifiers for profiles that match.

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:

A list of identifiers for profiles that match.

confidenceScore

public final Double confidenceScore()

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 an absolute measure of matching quality.

Returns:

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 an absolute measure of matching quality.

toBuilder

public MatchItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MatchItem.Builder,MatchItem>

builder

public static MatchItem.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo