Class PersonMatch
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PersonMatch.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Information about the faces in the input collection that match the face of a person in the video.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FaceMatches property.final int
hashCode()
final PersonDetail
person()
Information about the matched person.static Class
<? extends PersonMatch.Builder> final Long
The time, in milliseconds from the beginning of the video, that the person was matched in the video.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PersonMatch.Builder,
PersonMatch> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-