Package software.amazon.awssdk.services.rekognition.model

Class PersonMatch

java.lang.Object

software.amazon.awssdk.services.rekognition.model.PersonMatch

All Implemented Interfaces:

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

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

Information about a person whose face matches a face(s) in an Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (FaceMatch), information about the person (PersonDetail), and the time stamp for when the person was detected in a video. An array of PersonMatch objects is returned by GetFaceSearch.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PersonMatch.Builder

Method Summary

Modifier and Type	Method	Description
static PersonMatch.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FaceMatch>	faceMatches()	Information about the faces in the input collection that match the face of a person in the video.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFaceMatches()	For responses, this returns true if the service returned a value for the FaceMatches property.
int	hashCode()
PersonDetail	person()	Information about the matched person.
List<SdkField<?>>	sdkFields()
static Class<? extends PersonMatch.Builder>	serializableBuilderClass()
Long	timestamp()	The time, in milliseconds from the beginning of the video, that the person was matched in the video.
PersonMatch.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

timestamp

public final Long timestamp()

The time, in milliseconds from the beginning of the video, that the person was matched in the video.

Returns:

The time, in milliseconds from the beginning of the video, that the person was matched in the video.

person

public final PersonDetail person()

Information about the matched person.

Returns:

Information about the matched person.

hasFaceMatches

public final boolean hasFaceMatches()

For responses, this returns true if the service returned a value for the FaceMatches 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.

faceMatches

public final List<FaceMatch> faceMatches()

Information about the faces in the input collection that match the face of a person in the video.

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

Returns:

Information about the faces in the input collection that match the face of a person in the video.

toBuilder

public PersonMatch.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PersonMatch.Builder,PersonMatch>

builder

public static PersonMatch.Builder builder()

serializableBuilderClass

public static Class<? extends PersonMatch.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