Package com.onfido.model

Class ReportShared

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

    • Constructor Detail

      • ReportShared

        public ReportShared()

    • Method Detail

      • getId

        @Nonnull
public UUID getId()
        The unique identifier for the report. Read-only.
        Returns:
        id

      • setId

        public void setId​(UUID id)

      • getCreatedAt

        @Nullable
public OffsetDateTime getCreatedAt()
        The date and time at which the report was first initiated. Read-only.
        Returns:
        createdAt

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)

      • getHref

        @Nullable
public String getHref()
        The API endpoint to retrieve the report. Read-only.
        Returns:
        href

      • setHref

        public void setHref​(String href)

      • setStatus

        public void setStatus​(ReportStatus status)

      • setResult

        public void setResult​(ReportResult result)

      • getCheckId

        @Nullable
public UUID getCheckId()
        The ID of the check to which the report belongs. Read-only.
        Returns:
        checkId

      • setCheckId

        public void setCheckId​(UUID checkId)

      • getDocuments

        @Nullable
public List<ReportDocument> getDocuments()
        Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
        Returns:
        documents

      • setName

        public void setName​(ReportName name)

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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