Package ai.extend.types

Class WorkflowRunSummary

  • public final class WorkflowRunSummary
extends java.lang.Object

    • Method Detail

      • getObject

        public java.lang.String getObject()
        Returns:
        The type of object. In this case, it will always be "workflow_run".

      • getId

        public java.lang.String getId()
        Returns:
        The ID of the workflow run.

        Example: "workflow_run_Zk9mNP12Qw4-yTv8BdR3H"

      • getDashboardUrl

        public java.lang.String getDashboardUrl()
        Returns:
        A URL to view this workflow run in the Extend dashboard.

        Example: "https://dashboard.extend.ai/workflows/workflow_run_xKm9pNv3qWsY_jL2tR5Dh"

      • getReviewedByUser

        public java.util.Optional<java.lang.String> getReviewedByUser()
        Returns:
        The user of the person who reviewed the workflow run. Will be null if the workflow run has not been reviewed.

        Example: "jane.doe@example.com"

      • getReviewedAt

        public java.util.Optional<java.time.OffsetDateTime> getReviewedAt()
        Returns:
        The time (in UTC) at which the workflow run was reviewed. Will follow the RFC 3339 format. Will be null if the workflow run has not been reviewed.

        Example: "2024-03-21T16:45:00Z"

      • getInitialRunAt

        public java.util.Optional<java.time.OffsetDateTime> getInitialRunAt()
        Returns:
        The time (in UTC) at which the workflow was initially created. Will follow the RFC 3339 format. Will be null if the run hasn't started yet.

        Example: "2024-03-21T15:30:00Z"

      • getStartTime

        public java.util.Optional<java.time.OffsetDateTime> getStartTime()
        Returns:
        The start time (in UTC) that the workflow actually started executing. This occurs after the initialRunAt time. Will follow the RFC 3339 format. Will be null if not started.

        Example: "2024-03-21T15:30:00Z"

      • getEndTime

        public java.util.Optional<java.time.OffsetDateTime> getEndTime()
        Returns:
        The end time (in UTC) that the workflow finished. Will follow the RFC 3339 format. Will be null if not finished.

        Example: "2024-03-21T15:35:00Z"

      • getBatchId

        public java.util.Optional<java.lang.String> getBatchId()
        Returns:
        The batch ID of the workflow run. If that workflow run was created from a batch of files, all runs in that batch will have the same batch ID.

        Example: "batch_7Ws31-F5"

      • getRejectionNote

        public java.util.Optional<java.lang.String> getRejectionNote()
        Returns:
        The note that was added when the workflow run was rejected.

        Example: "Invalid invoice format"

      • getFiles

        public java.util.List<FileSummary> getFiles()
        Returns:
        The input files that this workflow run was executed on. Provided directly on the list response so you don't need to fetch each run individually to inspect its input.

      • getCreatedAt

        public java.time.OffsetDateTime getCreatedAt()

      • getUpdatedAt

        public java.time.OffsetDateTime getUpdatedAt()

      • getUsage

        public java.util.Optional<RunUsageSummary> getUsage()
        Returns:
        Usage credits consumed by this workflow run. Omits breakdown — fetch the full workflow run by id to see the per-line items for every contributing child run.

        Availability: Will not be returned for runs created before October 7, 2025 or for customers on legacy billing systems.

      • 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