Package ai.extend.types

Class WorkflowRunSummary.Builder

java.lang.Object

ai.extend.types.WorkflowRunSummary.Builder

All Implemented Interfaces:

WorkflowRunSummary._FinalStage, WorkflowRunSummary.CreatedAtStage, WorkflowRunSummary.IdStage, WorkflowRunSummary.StatusStage, WorkflowRunSummary.UpdatedAtStage, WorkflowRunSummary.WorkflowIdStage, WorkflowRunSummary.WorkflowNameStage, WorkflowRunSummary.WorkflowVersionIdStage

Enclosing class:

WorkflowRunSummary

public static final class WorkflowRunSummary.Builder
extends java.lang.Object
implements WorkflowRunSummary.IdStage, WorkflowRunSummary.StatusStage, WorkflowRunSummary.WorkflowIdStage, WorkflowRunSummary.WorkflowNameStage, WorkflowRunSummary.WorkflowVersionIdStage, WorkflowRunSummary.CreatedAtStage, WorkflowRunSummary.UpdatedAtStage, WorkflowRunSummary._FinalStage

Method Summary

Modifier and Type	Method	Description
WorkflowRunSummary._FinalStage	batchId(java.lang.String batchId)	The batch ID of the WorkflowRun.
WorkflowRunSummary._FinalStage	batchId(java.util.Optional<java.lang.String> batchId)	The batch ID of the WorkflowRun.
WorkflowRunSummary	build()
WorkflowRunSummary.UpdatedAtStage	createdAt(java.time.OffsetDateTime createdAt)	The time (in UTC) at which the workflow run was created.
WorkflowRunSummary._FinalStage	endTime(java.time.OffsetDateTime endTime)	The end time (in UTC) that the workflow finished.
WorkflowRunSummary._FinalStage	endTime(java.util.Optional<java.time.OffsetDateTime> endTime)	The end time (in UTC) that the workflow finished.
WorkflowRunSummary.Builder	from(WorkflowRunSummary other)
WorkflowRunSummary.StatusStage	id(java.lang.String id)	The ID of the workflow run.
WorkflowRunSummary._FinalStage	initialRunAt(java.time.OffsetDateTime initialRunAt)	The time (in UTC) at which the workflow was initially created.
WorkflowRunSummary._FinalStage	initialRunAt(java.util.Optional<java.time.OffsetDateTime> initialRunAt)	The time (in UTC) at which the workflow was initially created.
WorkflowRunSummary._FinalStage	rejectionNote(java.lang.String rejectionNote)	The note that was added when the workflow run was rejected.
WorkflowRunSummary._FinalStage	rejectionNote(java.util.Optional<java.lang.String> rejectionNote)	The note that was added when the workflow run was rejected.
WorkflowRunSummary._FinalStage	reviewedAt(java.time.OffsetDateTime reviewedAt)	The time (in UTC) at which the workflow run was reviewed.
WorkflowRunSummary._FinalStage	reviewedAt(java.util.Optional<java.time.OffsetDateTime> reviewedAt)	The time (in UTC) at which the workflow run was reviewed.
WorkflowRunSummary._FinalStage	reviewedByUser(java.lang.String reviewedByUser)	The user of the person who reviewed the workflow run.
WorkflowRunSummary._FinalStage	reviewedByUser(java.util.Optional<java.lang.String> reviewedByUser)	The user of the person who reviewed the workflow run.
WorkflowRunSummary._FinalStage	startTime(java.time.OffsetDateTime startTime)	The start time (in UTC) that the workflow actually started executing.
WorkflowRunSummary._FinalStage	startTime(java.util.Optional<java.time.OffsetDateTime> startTime)	The start time (in UTC) that the workflow actually started executing.
WorkflowRunSummary.WorkflowIdStage	status(WorkflowStatus status)
WorkflowRunSummary._FinalStage	updatedAt(java.time.OffsetDateTime updatedAt)	The time (in UTC) at which the workflow run was last updated.
WorkflowRunSummary.WorkflowNameStage	workflowId(java.lang.String workflowId)	The ID of the workflow that was run.
WorkflowRunSummary.WorkflowVersionIdStage	workflowName(java.lang.String workflowName)	The name of the workflow that was run.
WorkflowRunSummary.CreatedAtStage	workflowVersionId(java.lang.String workflowVersionId)	The ID of the workflow version that was run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public WorkflowRunSummary.Builder from(WorkflowRunSummary other)

Specified by:

from in interface WorkflowRunSummary.IdStage

id

public WorkflowRunSummary.StatusStage id(@NotNull
                                         java.lang.String id)

The ID of the workflow run.

Example: "workflow_run_Zk9mNP12Qw4-yTv8BdR3H"

The ID of the workflow run.

Example: "workflow_run_Zk9mNP12Qw4-yTv8BdR3H"

Specified by:

id in interface WorkflowRunSummary.IdStage

Returns:

Reference to this so that method calls can be chained together.

status

public WorkflowRunSummary.WorkflowIdStage status(@NotNull
                                                 WorkflowStatus status)

Specified by:

status in interface WorkflowRunSummary.StatusStage

workflowId

public WorkflowRunSummary.WorkflowNameStage workflowId(@NotNull
                                                       java.lang.String workflowId)

The ID of the workflow that was run. Will always start with "workflow".

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

The ID of the workflow that was run. Will always start with "workflow".

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

Specified by:

workflowId in interface WorkflowRunSummary.WorkflowIdStage

Returns:

Reference to this so that method calls can be chained together.

workflowName

public WorkflowRunSummary.WorkflowVersionIdStage workflowName(@NotNull
                                                              java.lang.String workflowName)

The name of the workflow that was run.

Example: "Invoice Processing"

The name of the workflow that was run.

Example: "Invoice Processing"

Specified by:

workflowName in interface WorkflowRunSummary.WorkflowNameStage

Returns:

Reference to this so that method calls can be chained together.

workflowVersionId

public WorkflowRunSummary.CreatedAtStage workflowVersionId(@NotNull
                                                           java.lang.String workflowVersionId)

The ID of the workflow version that was run. Will always start with "workflow_version".

Example: "workflow_version_Zk9mNP12Qw4-yTv8BdR3H"

The ID of the workflow version that was run. Will always start with "workflow_version".

Example: "workflow_version_Zk9mNP12Qw4-yTv8BdR3H"

Specified by:

workflowVersionId in interface WorkflowRunSummary.WorkflowVersionIdStage

Returns:

Reference to this so that method calls can be chained together.

createdAt

public WorkflowRunSummary.UpdatedAtStage createdAt(@NotNull
                                                   java.time.OffsetDateTime createdAt)

The time (in UTC) at which the workflow run was created. Will follow the RFC 3339 format.

Example: "2024-03-21T15:29:55Z"

The time (in UTC) at which the workflow run was created. Will follow the RFC 3339 format.

Example: "2024-03-21T15:29:55Z"

Specified by:

createdAt in interface WorkflowRunSummary.CreatedAtStage

Returns:

Reference to this so that method calls can be chained together.

updatedAt

public WorkflowRunSummary._FinalStage updatedAt(@NotNull
                                                java.time.OffsetDateTime updatedAt)

The time (in UTC) at which the workflow run was last updated. Will follow the RFC 3339 format.

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

The time (in UTC) at which the workflow run was last updated. Will follow the RFC 3339 format.

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

Specified by:

updatedAt in interface WorkflowRunSummary.UpdatedAtStage

Returns:

Reference to this so that method calls can be chained together.

rejectionNote

public WorkflowRunSummary._FinalStage rejectionNote(java.lang.String rejectionNote)

The note that was added when the workflow run was rejected.

Example: "Invalid invoice format"

Specified by:

rejectionNote in interface WorkflowRunSummary._FinalStage

Returns:

Reference to this so that method calls can be chained together.

rejectionNote

public WorkflowRunSummary._FinalStage rejectionNote(java.util.Optional<java.lang.String> rejectionNote)

The note that was added when the workflow run was rejected.

Example: "Invalid invoice format"

Specified by:

rejectionNote in interface WorkflowRunSummary._FinalStage

batchId

public WorkflowRunSummary._FinalStage batchId(java.lang.String batchId)

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"

Specified by:

batchId in interface WorkflowRunSummary._FinalStage

Returns:

Reference to this so that method calls can be chained together.

batchId

public WorkflowRunSummary._FinalStage batchId(java.util.Optional<java.lang.String> batchId)

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"

Specified by:

batchId in interface WorkflowRunSummary._FinalStage

endTime

public WorkflowRunSummary._FinalStage endTime(java.time.OffsetDateTime endTime)

The end time (in UTC) that the workflow finished. Will follow the RFC 3339 format.

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

Specified by:

endTime in interface WorkflowRunSummary._FinalStage

Returns:

Reference to this so that method calls can be chained together.

endTime

public WorkflowRunSummary._FinalStage endTime(java.util.Optional<java.time.OffsetDateTime> endTime)

The end time (in UTC) that the workflow finished. Will follow the RFC 3339 format.

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

Specified by:

endTime in interface WorkflowRunSummary._FinalStage

startTime

public WorkflowRunSummary._FinalStage startTime(java.time.OffsetDateTime startTime)

The start time (in UTC) that the workflow actually started executing. This occurs after the initialRunAt time. Will follow the RFC 3339 format.

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

Specified by:

startTime in interface WorkflowRunSummary._FinalStage

Returns:

Reference to this so that method calls can be chained together.

startTime

public WorkflowRunSummary._FinalStage startTime(java.util.Optional<java.time.OffsetDateTime> startTime)

The start time (in UTC) that the workflow actually started executing. This occurs after the initialRunAt time. Will follow the RFC 3339 format.

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

Specified by:

startTime in interface WorkflowRunSummary._FinalStage

reviewedAt

public WorkflowRunSummary._FinalStage reviewedAt(java.time.OffsetDateTime reviewedAt)

The time (in UTC) at which the workflow run was reviewed. Will follow the RFC 3339 format.

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

Specified by:

reviewedAt in interface WorkflowRunSummary._FinalStage

Returns:

Reference to this so that method calls can be chained together.

reviewedAt

public WorkflowRunSummary._FinalStage reviewedAt(java.util.Optional<java.time.OffsetDateTime> reviewedAt)

The time (in UTC) at which the workflow run was reviewed. Will follow the RFC 3339 format.

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

Specified by:

reviewedAt in interface WorkflowRunSummary._FinalStage

reviewedByUser

public WorkflowRunSummary._FinalStage reviewedByUser(java.lang.String reviewedByUser)

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"

Specified by:

reviewedByUser in interface WorkflowRunSummary._FinalStage

Returns:

Reference to this so that method calls can be chained together.

reviewedByUser

public WorkflowRunSummary._FinalStage reviewedByUser(java.util.Optional<java.lang.String> reviewedByUser)

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"

Specified by:

reviewedByUser in interface WorkflowRunSummary._FinalStage

initialRunAt

public WorkflowRunSummary._FinalStage initialRunAt(java.time.OffsetDateTime initialRunAt)

The time (in UTC) at which the workflow was initially created. Will follow the RFC 3339 format.

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

Specified by:

initialRunAt in interface WorkflowRunSummary._FinalStage

Returns:

Reference to this so that method calls can be chained together.

initialRunAt

public WorkflowRunSummary._FinalStage initialRunAt(java.util.Optional<java.time.OffsetDateTime> initialRunAt)

The time (in UTC) at which the workflow was initially created. Will follow the RFC 3339 format.

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

Specified by:

initialRunAt in interface WorkflowRunSummary._FinalStage

build

public WorkflowRunSummary build()

Specified by:

build in interface WorkflowRunSummary._FinalStage