Package ai.extend.types
Class WorkflowRunSummary
- java.lang.Object
-
- ai.extend.types.WorkflowRunSummary
-
public final class WorkflowRunSummary extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceWorkflowRunSummary._FinalStagestatic classWorkflowRunSummary.Builderstatic interfaceWorkflowRunSummary.CreatedAtStagestatic interfaceWorkflowRunSummary.IdStagestatic interfaceWorkflowRunSummary.StatusStagestatic interfaceWorkflowRunSummary.UpdatedAtStagestatic interfaceWorkflowRunSummary.WorkflowIdStagestatic interfaceWorkflowRunSummary.WorkflowNameStagestatic interfaceWorkflowRunSummary.WorkflowVersionIdStage
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WorkflowRunSummary.IdStagebuilder()booleanequals(java.lang.Object other)java.util.Map<java.lang.String,java.lang.Object>getAdditionalProperties()java.util.Optional<java.lang.String>getBatchId()java.time.OffsetDateTimegetCreatedAt()java.util.Optional<java.time.OffsetDateTime>getEndTime()java.lang.StringgetId()java.util.Optional<java.time.OffsetDateTime>getInitialRunAt()java.util.Optional<java.lang.String>getRejectionNote()java.util.Optional<java.time.OffsetDateTime>getReviewedAt()java.util.Optional<java.lang.String>getReviewedByUser()java.util.Optional<java.time.OffsetDateTime>getStartTime()WorkflowStatusgetStatus()java.time.OffsetDateTimegetUpdatedAt()java.util.Optional<WorkflowRunCredits>getUsage()java.lang.StringgetWorkflowId()java.lang.StringgetWorkflowName()java.lang.StringgetWorkflowVersionId()inthashCode()java.lang.StringtoString()
-
-
-
Method Detail
-
getId
public java.lang.String getId()
- Returns:
- The ID of the workflow run.
Example:
"workflow_run_Zk9mNP12Qw4-yTv8BdR3H"
-
getStatus
public WorkflowStatus getStatus()
-
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.
Example:
"2024-03-21T15:30:00Z"
-
getReviewedByUser
public java.util.Optional<java.lang.String> getReviewedByUser()
- Returns:
- The user of the person who reviewed the workflow run. Will not be included 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.
Example:
"2024-03-21T16:45: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
initialRunAttime. Will follow the RFC 3339 format.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.
Example:
"2024-03-21T15:35:00Z"
-
getWorkflowId
public java.lang.String getWorkflowId()
- Returns:
- The ID of the workflow that was run. Will always start with "workflow".
Example:
"workflow_BMdfq_yWM3sT-ZzvCnA3f"
-
getWorkflowName
public java.lang.String getWorkflowName()
- Returns:
- The name of the workflow that was run.
Example:
"Invoice Processing"
-
getWorkflowVersionId
public java.lang.String getWorkflowVersionId()
- Returns:
- The ID of the workflow version that was run. Will always start with "workflow_version".
Example:
"workflow_version_Zk9mNP12Qw4-yTv8BdR3H"
-
getBatchId
public java.util.Optional<java.lang.String> getBatchId()
- Returns:
- The batch ID of the WorkflowRun. If that WorkflowRun 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"
-
getCreatedAt
public java.time.OffsetDateTime getCreatedAt()
- Returns:
- The time (in UTC) at which the workflow run was created. Will follow the RFC 3339 format.
Example:
"2024-03-21T15:29:55Z"
-
getUpdatedAt
public java.time.OffsetDateTime getUpdatedAt()
- Returns:
- The time (in UTC) at which the workflow run was last updated. Will follow the RFC 3339 format.
Example:
"2024-03-21T16:45:00Z"
-
getUsage
public java.util.Optional<WorkflowRunCredits> getUsage()
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equalsin classjava.lang.Object
-
getAdditionalProperties
public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
builder
public static WorkflowRunSummary.IdStage builder()
-
-