Class JobResult


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

      • JobResult

        public JobResult()
    • Method Detail

      • setId

        public void setId​(String id)
      • setType

        public void setType​(String type)
      • getDryRun

        @Nullable
        public Boolean getDryRun()
        Dry run. If `true`, this job only simulates the changes but doesn't actually persist them.
        Returns:
        dryRun
      • setDryRun

        public void setDryRun​(Boolean dryRun)
      • getUpsert

        @Nullable
        public Boolean getUpsert()
        Upsert. If `true`, this job will first attempt to update existing records if matches can be found. Matches are done in the following order: * Form ID * Form Reference ID and tax year * Form TIN and tax year
        Returns:
        upsert
      • setUpsert

        public void setUpsert​(Boolean upsert)
      • getStatus

        @Nullable
        public String getStatus()
        Status of the job
        Returns:
        status
      • setStatus

        public void setStatus​(String status)
      • getErrorMessage

        @Nullable
        public String getErrorMessage()
        Get errorMessage
        Returns:
        errorMessage
      • setErrorMessage

        public void setErrorMessage​(String errorMessage)
      • getTotalProcessed

        @Nullable
        public Integer getTotalProcessed()
        Total number of forms processed
        Returns:
        totalProcessed
      • setTotalProcessed

        public void setTotalProcessed​(Integer totalProcessed)
      • getTotalRows

        @Nullable
        public Integer getTotalRows()
        Total number of forms in the request
        Returns:
        totalRows
      • setTotalRows

        public void setTotalRows​(Integer totalRows)
      • getUpdatedValid

        @Nullable
        public Integer getUpdatedValid()
        Number of forms updated and valid for e-filing and e-delivery
        Returns:
        updatedValid
      • setUpdatedValid

        public void setUpdatedValid​(Integer updatedValid)
      • getUpdatedNoEmail

        @Nullable
        public Integer getUpdatedNoEmail()
        Number of forms updated and valid for e-filing but missing email or email is undeliverable
        Returns:
        updatedNoEmail
      • setUpdatedNoEmail

        public void setUpdatedNoEmail​(Integer updatedNoEmail)
      • getUpdatedInvalid

        @Nullable
        public Integer getUpdatedInvalid()
        Number of forms updated but invalid for e-filing
        Returns:
        updatedInvalid
      • setUpdatedInvalid

        public void setUpdatedInvalid​(Integer updatedInvalid)
      • skippedDuplicate

        public JobResult skippedDuplicate​(Integer skippedDuplicate)
      • getSkippedDuplicate

        @Nullable
        public Integer getSkippedDuplicate()
        Number of forms skipped because they would have updated a record already updated once in the request
        Returns:
        skippedDuplicate
      • setSkippedDuplicate

        public void setSkippedDuplicate​(Integer skippedDuplicate)
      • getSkippedInvalid

        @Nullable
        public Integer getSkippedInvalid()
        Number of forms skipped because they would have made a form invalid and the form is already e-filed or scheduled for e-filing
        Returns:
        skippedInvalid
      • setSkippedInvalid

        public void setSkippedInvalid​(Integer skippedInvalid)
      • skippedMultipleMatches

        public JobResult skippedMultipleMatches​(Integer skippedMultipleMatches)
      • getSkippedMultipleMatches

        @Nullable
        public Integer getSkippedMultipleMatches()
        Number of forms skipped because they matched multiple forms
        Returns:
        skippedMultipleMatches
      • setSkippedMultipleMatches

        public void setSkippedMultipleMatches​(Integer skippedMultipleMatches)
      • getNotFound

        @Nullable
        public Integer getNotFound()
        Number of forms skipped because no matching form or issuer could be found
        Returns:
        notFound
      • setNotFound

        public void setNotFound​(Integer notFound)
      • getCreatedInvalid

        @Nullable
        public Integer getCreatedInvalid()
        Number of new forms created because no matching form could be found (and `upsert` was true) - with errors
        Returns:
        createdInvalid
      • setCreatedInvalid

        public void setCreatedInvalid​(Integer createdInvalid)
      • getCreatedNoEmail

        @Nullable
        public Integer getCreatedNoEmail()
        Number of new forms created because no matching form could be found (and `upsert` was true) - valid for e-filing but missing email or email is undeliverable
        Returns:
        createdNoEmail
      • setCreatedNoEmail

        public void setCreatedNoEmail​(Integer createdNoEmail)
      • getCreatedValid

        @Nullable
        public Integer getCreatedValid()
        Number of new forms created because no matching form could be found (and `upsert` was true) - valid for e-filing and e-delivery
        Returns:
        createdValid
      • setCreatedValid

        public void setCreatedValid​(Integer createdValid)
      • 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 JobResult
      • fromJson

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

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