Class DocumentReference


  • public class DocumentReference
    extends Object
    DocumentReference
    • Constructor Detail

      • DocumentReference

        public DocumentReference()
    • Method Detail

      • getActive

        public Boolean getActive()
        Identifies whether the document is active and used for checks.
        Returns:
        active
      • setActive

        public void setActive​(Boolean active)
      • getDescription

        public String getDescription()
        Your description for the document.
        Returns:
        description
      • setDescription

        public void setDescription​(String description)
      • getFileName

        public String getFileName()
        Document name.
        Returns:
        fileName
      • setFileName

        public void setFileName​(String fileName)
      • getId

        public String getId()
        The unique identifier of the resource.
        Returns:
        id
      • setId

        public void setId​(String id)
      • getModificationDate

        public OffsetDateTime getModificationDate()
        The modification date of the document.
        Returns:
        modificationDate
      • setModificationDate

        public void setModificationDate​(OffsetDateTime modificationDate)
      • getType

        public String getType()
        Type of document, used when providing an ID number or uploading a document.
        Returns:
        type
      • setType

        public void setType​(String type)
      • hashCode

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

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                                       throws IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        IOException - if the JSON Object is invalid with respect to DocumentReference
      • fromJson

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

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