Class FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               comments="Generator version: 7.9.0")
    public class FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties
    extends Object
    FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties
    • Constructor Detail

      • FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties

        public FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties()
    • Method Detail

      • getScore

        @Nullable
        public Float getScore()
        A floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match.
        Returns:
        score
      • setScore

        public void setScore​(Float score)
      • getDocumentId

        @Nullable
        public UUID getDocumentId()
        The UUID for the document containing the extracted face that was used for face matching.
        Returns:
        documentId
      • setDocumentId

        public void setDocumentId​(UUID documentId)
      • putAdditionalProperty

        public FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties putAdditionalProperty​(String key,
                                                                                                              Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
        Parameters:
        key - name of the property
        value - value of the property
        Returns:
        the FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties instance itself
      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
        Return the additional (undeclared) property.
        Returns:
        a map of objects
      • getAdditionalProperty

        public Object getAdditionalProperty​(String key)
        Return the additional (undeclared) property with the specified name.
        Parameters:
        key - name of the property
        Returns:
        an object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                        throws IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        IOException - if the JSON Element is invalid with respect to FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties
      • fromJson

        public static FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties fromJson​(String jsonString)
                                                                                                 throws IOException
        Create an instance of FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties
        Throws:
        IOException - if the JSON string is invalid with respect to FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties
      • toJson

        public String toJson()
        Convert an instance of FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties to an JSON string
        Returns:
        JSON string