Package ai.extend.types

Class WorkflowRun

  • public final class WorkflowRun
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_xKm9pNv3qWsY_jL2tR5Dh"

      • 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"

      • getMetadata

        public java.util.Map<java.lang.String,​java.lang.Object> getMetadata()
        Returns:
        The metadata that was passed in when running the Workflow.

      • getBatchId

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

        Example: "batch_7Ws31-F5"

      • getFiles

        public java.util.List<FileSummary> getFiles()

      • getFailureReason

        public java.util.Optional<java.lang.String> getFailureReason()
        Returns:
        The reason why the workflow run failed. Will only be included if the workflow run status is "FAILED".

      • getFailureMessage

        public java.util.Optional<java.lang.String> getFailureMessage()
        Returns:
        A more detailed message about the failure. Will only be included if the workflow run status is "FAILED".

      • getInitialRunAt

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

        Example: "2025-04-28T17:01:39.285Z"

      • getReviewedByUser

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

        Example: "jane.doe@example.com"

      • getReviewed

        public boolean getReviewed()
        Returns:
        Whether the workflow run has been reviewed.

      • getRejectionNote

        public java.util.Optional<java.lang.String> getRejectionNote()
        Returns:
        A note that is added if a workflow run is rejected.

        Example: "Invalid invoice format"

      • 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"

      • getStartTime

        public java.util.Optional<java.time.OffsetDateTime> getStartTime()
        Returns:
        The time (in UTC) at which the workflow run started executing. This will always be after the initialRunAt time. Will follow the RFC 3339 format. Will be null if the workflow run has not started executing.

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

      • getEndTime

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

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

      • getStepRuns

        public java.util.List<StepRun> getStepRuns()
        Returns:
        An array of WorkflowStepRun objects. Each WorkflowStepRun represents a single run of a WorkflowStep and contains details about the step's execution and result.

      • getUsage

        public java.util.Optional<RunUsage> getUsage()
        Returns:
        Usage credits consumed by this workflow run, including a breakdown of 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