Package markets.alpaca.client.openapi.broker.model

Class CIPPhoto

java.lang.Object
markets.alpaca.client.openapi.broker.model.CIPPhoto
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CIPPhoto extends Object implements Serializable
Represents the results of checking a Photo for CIPInfo
See Also:

  • Field Details

  • Constructor Details

    • CIPPhoto

      public CIPPhoto()

  • Method Details

    • createdAt

      public CIPPhoto createdAt(@Nullable String createdAt)

    • getCreatedAt

      @Nullable public String getCreatedAt()
      datetime of when the check happened
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable String createdAt)

    • faceComparison

      public CIPPhoto faceComparison(@Nullable String faceComparison)

    • getFaceComparison

      @Nullable public String getFaceComparison()
      The result of the check. Either `clear` or `consider`.
      Returns:
      faceComparison

    • setFaceComparison

      public void setFaceComparison(@Nullable String faceComparison)

    • faceComparisonBreakdown

      public CIPPhoto faceComparisonBreakdown(@Nullable String faceComparisonBreakdown)

    • getFaceComparisonBreakdown

      @Nullable public String getFaceComparisonBreakdown()
      a json object representing the breakdown of sub-checks done in `face_comparison`. Example: {\"face_match\":{\"result\": \"clear\",\"properties\":{\"score\": \"80\"}}}
      Returns:
      faceComparisonBreakdown

    • setFaceComparisonBreakdown

      public void setFaceComparisonBreakdown(@Nullable String faceComparisonBreakdown)

    • id

      public CIPPhoto id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      Your internal ID of the check
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • imageIntegrity

      public CIPPhoto imageIntegrity(@Nullable String imageIntegrity)

    • getImageIntegrity

      @Nullable public String getImageIntegrity()
      The result of the check. Either `clear` or `consider`.
      Returns:
      imageIntegrity

    • setImageIntegrity

      public void setImageIntegrity(@Nullable String imageIntegrity)

    • imageIntegrityBreakdown

      public CIPPhoto imageIntegrityBreakdown(@Nullable String imageIntegrityBreakdown)

    • getImageIntegrityBreakdown

      @Nullable public String getImageIntegrityBreakdown()
      a json object representing the breakdown of sub-checks done in `image_integrity`. Example {\"face_detected\":{\"result\": \"clear\"},\"source_integrity\": {\"result\": \"clear\"}}
      Returns:
      imageIntegrityBreakdown

    • setImageIntegrityBreakdown

      public void setImageIntegrityBreakdown(@Nullable String imageIntegrityBreakdown)

    • result

      public CIPPhoto result(@Nullable String result)

    • getResult

      @Nullable public String getResult()
      The result of the check. Either `clear` or `consider`.
      Returns:
      result

    • setResult

      public void setResult(@Nullable String result)

    • status

      public CIPPhoto status(@Nullable CIPPhoto.StatusEnum status)

    • getStatus

      @Nullable public CIPPhoto.StatusEnum getStatus()
      Overall status of the check. Either `complete` or `withdrawn`.
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable CIPPhoto.StatusEnum status)

    • visualAuthenticity

      public CIPPhoto visualAuthenticity(@Nullable String visualAuthenticity)

    • getVisualAuthenticity

      @Nullable public String getVisualAuthenticity()
      The result of the check. Either `clear` or `consider`.
      Returns:
      visualAuthenticity

    • setVisualAuthenticity

      public void setVisualAuthenticity(@Nullable String visualAuthenticity)

    • visualAuthenticityBreakdown

      public CIPPhoto visualAuthenticityBreakdown(@Nullable String visualAuthenticityBreakdown)

    • getVisualAuthenticityBreakdown

      @Nullable public String getVisualAuthenticityBreakdown()
      a json object representing the breakdown of sub-checks don in `visual_authenticity`. Example {\"spoofing_detection\": {\"result\": \"clear\",\"properties\": {\"score\": \"26\"}}}}
      Returns:
      visualAuthenticityBreakdown

    • setVisualAuthenticityBreakdown

      public void setVisualAuthenticityBreakdown(@Nullable String visualAuthenticityBreakdown)

    • putAdditionalProperty

      public CIPPhoto 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 CIPPhoto 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

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString 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 CIPPhoto

    • fromJson

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

    • toJson

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