v1_workflows

package
v0.59.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2025 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const SimpleEvent = "simple-event:create"

❓ Run workflow on event

Variables

This section is empty.

Functions

func NonRetryableError added in v0.58.0

NonRetryableError returns a workflow which throws a non-retryable error

func OnCron added in v0.57.0

❓ Workflow Definition Cron Trigger

func ParentTask added in v0.58.1

func Priority added in v0.59.0

func RateLimit added in v0.58.1

❓ Dynamic Rate Limit

func Retries added in v0.57.0

Simple retries example that always fails

func RetriesWithCount added in v0.57.0

Retries example that succeeds after a certain number of retries

func StaticRateLimit added in v0.58.1

❓ Static Rate Limit

func Sticky added in v0.57.0

func StickyDag added in v0.57.0

func TaskConditionWorkflow added in v0.58.1

func TaskConditionWorkflow(hatchet v1.HatchetClient) workflow.WorkflowDeclaration[struct{}, TaskConditionWorkflowResult]

func Timeout added in v0.57.0

func WithBackoff added in v0.57.0

Retries example with simple backoff (no configuration in this API version)

Types

type AlwaysFailsOutput

type AlwaysFailsOutput struct {
	TransformedMessage string
}

type BackoffInput added in v0.57.0

type BackoffInput struct{}

type BackoffResult added in v0.57.0

type BackoffResult struct{}

type CancellationInput added in v0.57.0

type CancellationInput struct{}

type CancellationResult added in v0.57.0

type CancellationResult struct {
	Completed bool
}

type ChildInput

type ChildInput struct {
	N int `json:"n"`
}

type ConcurrencyInput

type ConcurrencyInput struct {
	Message  string
	GroupKey string
}

type DagInput added in v0.57.0

type DagInput struct {
	Message string
}

type DagResult

type DagResult struct {
	Step1 SimpleOutput
	Step2 SimpleOutput
}

type DagWithConditionsInput added in v0.57.0

type DagWithConditionsInput struct {
	Message string
}

type DagWithConditionsResult added in v0.57.0

type DagWithConditionsResult struct {
	Step1 SimpleOutput
	Step2 SimpleOutput
}

type DurableEventInput added in v0.57.0

type DurableEventInput struct {
	Message string
}

type DurableEventOutput added in v0.57.0

type DurableEventOutput struct {
	Data EventData
}

type DurableSleepInput

type DurableSleepInput struct {
	Message string
}

type DurableSleepOutput

type DurableSleepOutput struct {
	TransformedMessage string
}

type EventData added in v0.57.0

type EventData struct {
	Message string
}

type EventInput

type EventInput struct {
	Message string
}

type JobResult added in v0.57.0

type JobResult struct {
	TransformedMessage string `json:"TransformedMessage"`
}

type LowerTaskOutput

type LowerTaskOutput struct {
	TransformedMessage string
}

type NonRetryableInput added in v0.58.0

type NonRetryableInput struct{}

type NonRetryableResult added in v0.58.0

type NonRetryableResult struct{}

type OnCronInput added in v0.57.0

type OnCronInput struct {
	Message string `json:"Message"`
}

type OnCronOutput added in v0.57.0

type OnCronOutput struct {
	Job JobResult `json:"job"`
}

type OnFailureOutput

type OnFailureOutput struct {
	FailureRan bool
}

type OnFailureSuccessResult

type OnFailureSuccessResult struct {
	AlwaysFails AlwaysFailsOutput
}

type ParentInput

type ParentInput struct {
	N int `json:"n"`
}

type PriorityInput added in v0.59.0

type PriorityInput struct {
	UserId string `json:"userId"`
}

type PriorityOutput added in v0.59.0

type PriorityOutput struct {
	TransformedMessage string `json:"TransformedMessage"`
}

type RandomSum added in v0.58.1

type RandomSum struct {
	Sum int `json:"sum"`
}

RandomSum represents the output of the sum task

type RateLimitInput added in v0.58.1

type RateLimitInput struct {
	UserId string `json:"userId"`
}

type RateLimitOutput added in v0.58.1

type RateLimitOutput struct {
	TransformedMessage string `json:"TransformedMessage"`
}

type Result added in v0.59.0

type Result struct {
	Step PriorityOutput
}

type RetriesInput added in v0.57.0

type RetriesInput struct{}

type RetriesResult added in v0.57.0

type RetriesResult struct{}

type RetriesWithCountInput added in v0.57.0

type RetriesWithCountInput struct{}

type RetriesWithCountResult added in v0.57.0

type RetriesWithCountResult struct {
	Message string `json:"message"`
}

type SimpleInput

type SimpleInput struct {
	Message string
}

type SimpleOutput

type SimpleOutput struct {
	Step int
}

type SimpleResult

type SimpleResult struct {
	TransformedMessage string
}

type StepOutput added in v0.58.1

type StepOutput struct {
	RandomNumber int `json:"randomNumber"`
}

StepOutput represents the output of most tasks in this workflow

type StickyDagResult added in v0.57.0

type StickyDagResult struct {
	StickyTask1 StickyResult `json:"sticky-task-1"`
	StickyTask2 StickyResult `json:"sticky-task-2"`
}

type StickyInput added in v0.57.0

type StickyInput struct{}

type StickyResult added in v0.57.0

type StickyResult struct {
	Result string `json:"result"`
}

type SumOutput

type SumOutput struct {
	Result int `json:"result"`
}

type TaskConditionWorkflowResult added in v0.58.1

type TaskConditionWorkflowResult struct {
	Start        StepOutput `json:"start"`
	WaitForSleep StepOutput `json:"waitForSleep"`
	WaitForEvent StepOutput `json:"waitForEvent"`
	SkipOnEvent  StepOutput `json:"skipOnEvent"`
	LeftBranch   StepOutput `json:"leftBranch"`
	RightBranch  StepOutput `json:"rightBranch"`
	Sum          RandomSum  `json:"sum"`
}

TaskConditionWorkflowResult represents the aggregate output of all tasks

type TimeoutInput added in v0.57.0

type TimeoutInput struct{}

type TimeoutResult added in v0.57.0

type TimeoutResult struct {
	Completed bool
}

type TransformedOutput

type TransformedOutput struct {
	TransformedMessage string
}

type UpperTaskOutput

type UpperTaskOutput struct {
	TransformedMessage string
}

type ValueOutput

type ValueOutput struct {
	Value int `json:"value"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL