Class ExtractRunSummary


  • public final class ExtractRunSummary
    extends java.lang.Object
    • Method Detail

      • getObject

        public java.lang.String getObject()
        Returns:
        The type of object. Will always be "extract_run".
      • getId

        public java.lang.String getId()
        Returns:
        The unique identifier for this extract run.
      • getExtractor

        public java.util.Optional<ExtractorSummary> getExtractor()
        Returns:
        The extractor that was used for this run.

        Availability: Present when an extractor reference was provided. Not present when using inline config.

      • getExtractorVersion

        public java.util.Optional<ExtractorVersionSummary> getExtractorVersion()
        Returns:
        The version of the extractor that was used for this run.

        Availability: Present when an extractor reference was provided. Not present when using inline config.

      • getFailureReason

        public java.util.Optional<java.lang.String> getFailureReason()
        Returns:
        The reason for failure.

        Availability: Present when status is "FAILED".

      • getFailureMessage

        public java.util.Optional<java.lang.String> getFailureMessage()
        Returns:
        A detailed message about the failure.

        Availability: Present when status is "FAILED".

      • getMetadata

        public java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>> getMetadata()
        Returns:
        Any metadata that was provided when creating the extract run.

        Availability: Present when metadata was provided during creation.

      • getReviewed

        public boolean getReviewed()
        Returns:
        Indicates whether the run has been reviewed by a human.
      • getEdited

        public boolean getEdited()
        Returns:
        Indicates whether the run results have been edited during review.
      • getFile

        public FileSummary getFile()
        Returns:
        The file that was processed.
      • getParseRunId

        public java.util.Optional<java.lang.String> getParseRunId()
        Returns:
        The ID of the parse run that was used for this extract run.

        Availability: Present when a parse run was created.

      • getDashboardUrl

        public java.lang.String getDashboardUrl()
        Returns:
        The URL to view the extract run in the Extend dashboard.
      • getUsage

        public java.util.Optional<RunUsage> getUsage()
        Returns:
        Usage credits consumed by this run.

        Availability: Present when status is "PROCESSED".

      • getCreatedAt

        public java.time.OffsetDateTime getCreatedAt()
      • getUpdatedAt

        public java.time.OffsetDateTime getUpdatedAt()
      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object