Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Heartbeat (HeartbeatRequest, HeartbeatResponse)

  dispatcher.proto:17

  Heartbeat is a method for workers to send heartbeats to the dispatcher

  message HeartbeatRequest

  dispatcher.proto:378

  • string workerId = 1

    the id of the worker

  • optional google.protobuf.Timestamp heartbeatAt = 2

    heartbeatAt is the time the worker sent the heartbeat

  message HeartbeatResponse

  dispatcher.proto:386

  (message has no fields)

• rpc Listen (WorkerListenRequest, stream AssignedAction)

  dispatcher.proto:10

• rpc ListenV2 (WorkerListenRequest, stream AssignedAction)

  dispatcher.proto:14

  ListenV2 is like listen, but implementation does not include heartbeats. This should only used by SDKs against engine version v0.18.1+

• rpc PutOverridesData (OverridesData, OverridesDataResponse)

  dispatcher.proto:27

  message OverridesData

  dispatcher.proto:362

  • string stepRunId = 1

    the step run id

  • string path = 2

    the path of the data to set

  • string value = 3

    the value to set

  • string callerFilename = 4

    the filename of the caller

  message OverridesDataResponse

  dispatcher.proto:376

  (message has no fields)

• rpc RefreshTimeout (RefreshTimeoutRequest, RefreshTimeoutResponse)

  dispatcher.proto:31

  message RefreshTimeoutRequest

  dispatcher.proto:388

  • string stepRunId = 1

    the id of the step run to release

  • string incrementTimeoutBy = 2

  message RefreshTimeoutResponse

  dispatcher.proto:395

  • optional google.protobuf.Timestamp timeoutAt = 1

• rpc Register (WorkerRegisterRequest, WorkerRegisterResponse)

  dispatcher.proto:8

  message WorkerRegisterRequest

  dispatcher.proto:59

  • string workerName = 1

    the name of the worker

  • repeated string actions = 2

    a list of actions that this worker can run

  • repeated string services = 3

    (optional) the services for this worker

  • optional int32 maxRuns = 4

    (optional) the max number of runs this worker can handle

  • map<string, WorkerLabels> labels = 5

    (optional) worker labels (i.e. state or other metadata)

  • optional string webhookId = 6

    (optional) webhookId is the id of the webhook that the worker is associated with (if any)

  • optional RuntimeInfo runtimeInfo = 7

    (optional) information regarding the runtime environment of the worker

  message WorkerRegisterResponse

  dispatcher.proto:83

  • string tenantId = 1

    the tenant id

  • string workerId = 2

    the id of the worker

  • string workerName = 3

    the name of the worker

• rpc ReleaseSlot (ReleaseSlotRequest, ReleaseSlotResponse)

  dispatcher.proto:33

  message ReleaseSlotRequest

  dispatcher.proto:399

  • string stepRunId = 1

    the id of the step run to release

  message ReleaseSlotResponse

  dispatcher.proto:404

  (message has no fields)

• rpc SendGroupKeyActionEvent (GroupKeyActionEvent, ActionEventResponse)

  dispatcher.proto:25

  message GroupKeyActionEvent

  dispatcher.proto:204

  • string workerId = 1

    the id of the worker

  • string workflowRunId = 2

    the id of the job

  • string getGroupKeyRunId = 3

  • string actionId = 4

    the action id

  • optional google.protobuf.Timestamp eventTimestamp = 5

  • GroupKeyActionEventType eventType = 6

    the step event type

  • string eventPayload = 7

    the event payload

• rpc SendStepActionEvent (StepActionEvent, ActionEventResponse)

  dispatcher.proto:23

  message StepActionEvent

  dispatcher.proto:233

  • string workerId = 1

    the id of the worker

  • string jobId = 2

    the id of the job

  • string jobRunId = 3

    the job run id

  • string stepId = 4

    the id of the step

  • string stepRunId = 5

    the step run id

  • string actionId = 6

    the action id

  • optional google.protobuf.Timestamp eventTimestamp = 7

  • StepActionEventType eventType = 8

    the step event type

  • string eventPayload = 9

    the event payload

  • optional int32 retryCount = 10

    the retry count

  • optional bool shouldNotRetry = 11

    a flag indicating if the task should _not_ be retried

• rpc SubscribeToWorkflowEvents (SubscribeToWorkflowEventsRequest, stream WorkflowEvent)

  dispatcher.proto:19

  message SubscribeToWorkflowEventsRequest

  dispatcher.proto:275

  • optional string workflowRunId = 1

    the id of the workflow run

  • optional string additionalMetaKey = 2

    the key of the additional meta field to subscribe to

  • optional string additionalMetaValue = 3

    the value of the additional meta field to subscribe to

  message WorkflowEvent

  dispatcher.proto:307

  • string workflowRunId = 1

    the id of the workflow run

  • ResourceType resourceType = 2

  • ResourceEventType eventType = 3

  • string resourceId = 4

  • optional google.protobuf.Timestamp eventTimestamp = 5

  • string eventPayload = 6

    the event payload

  • bool hangup = 7

    whether this is the last event for the workflow run - server will hang up the connection but clients might want to case

  • optional int32 stepRetries = 8

    (optional) the max number of retries this step can handle

  • optional int32 retryCount = 9

    (optional) the retry count of this step

  • optional int64 eventIndex = 10

• rpc SubscribeToWorkflowRuns (stream SubscribeToWorkflowRunsRequest, stream WorkflowRunEvent)

  dispatcher.proto:21

  message SubscribeToWorkflowRunsRequest

  dispatcher.proto:286

  • string workflowRunId = 1

    the id of the workflow run

  message WorkflowRunEvent

  dispatcher.proto:339

  • string workflowRunId = 1

    the id of the workflow run

  • WorkflowRunEventType eventType = 2

  • optional google.protobuf.Timestamp eventTimestamp = 3

  • repeated StepRunResult results = 4

• rpc Unsubscribe (WorkerUnsubscribeRequest, WorkerUnsubscribeResponse)

  dispatcher.proto:29

  message WorkerUnsubscribeRequest

  dispatcher.proto:184

  • string workerId = 1

    the id of the worker

  message WorkerUnsubscribeResponse

  dispatcher.proto:189

  • string tenantId = 1

    the tenant id to unsubscribe from

  • string workerId = 2

    the id of the worker

• rpc UpsertWorkerLabels (UpsertWorkerLabelsRequest, UpsertWorkerLabelsResponse)

  dispatcher.proto:35

  message UpsertWorkerLabelsRequest

  dispatcher.proto:94

  • string workerId = 1

    the name of the worker

  • map<string, WorkerLabels> labels = 2

    (optional) the worker labels

  message UpsertWorkerLabelsResponse

  dispatcher.proto:103

  • string tenantId = 1

    the tenant id

  • string workerId = 2

    the id of the worker

• rpc BulkPush (BulkPushEventRequest, Events)

  events.proto:10

  message BulkPushEventRequest

  events.proto:88

  • repeated PushEventRequest events = 1

  message Events

  events.proto:43

  • repeated Event events = 1

• rpc Push (PushEventRequest, Event)

  events.proto:8

• rpc PutLog (PutLogRequest, PutLogResponse)

  events.proto:14

  message PutLogRequest

  events.proto:47

  • string stepRunId = 1

    the step run id for the request

  • optional google.protobuf.Timestamp createdAt = 2

    when the log line was created

  • string message = 3

    the log line message

  • optional string level = 4

    the log line level

  • string metadata = 5

    associated log line metadata

  • optional int32 taskRetryCount = 6

    the retry count of the task run

  message PutLogResponse

  events.proto:67

  (message has no fields)

• rpc PutStreamEvent (PutStreamEventRequest, PutStreamEventResponse)

  events.proto:16

  message PutStreamEventRequest

  events.proto:69

  • string stepRunId = 1

    the step run id for the request

  • optional google.protobuf.Timestamp createdAt = 2

    when the stream event was created

  • bytes message = 3

    the stream event message

  • string metadata = 5

    associated stream event metadata

  • optional int64 eventIndex = 6

  message PutStreamEventResponse

  events.proto:85

  (message has no fields)

• rpc ReplaySingleEvent (ReplayEventRequest, Event)

  events.proto:12

  message ReplayEventRequest

  events.proto:112

  • string eventId = 1

    the event id to replay

WorkflowService represents a set of RPCs for managing workflows.

• rpc BulkTriggerWorkflow (BulkTriggerWorkflowRequest, BulkTriggerWorkflowResponse)

  workflows.proto:12

  message BulkTriggerWorkflowRequest

  workflows.proto:194

  • repeated TriggerWorkflowRequest workflows = 1

  message BulkTriggerWorkflowResponse

  workflows.proto:198

  • repeated string workflow_run_ids = 1

• rpc PutRateLimit (PutRateLimitRequest, PutRateLimitResponse)

  workflows.proto:13

  message PutRateLimitRequest

  workflows.proto:249

  • string key = 1

    (required) the global key for the rate limit

  • int32 limit = 2

    (required) the max limit for the rate limit (per unit of time)

  • RateLimitDuration duration = 3

    (required) the duration of time for the rate limit (second|minute|hour)

  message PutRateLimitResponse

  workflows.proto:260

  (message has no fields)

• rpc PutWorkflow (PutWorkflowRequest, WorkflowVersion)

  workflows.proto:9

  message PutWorkflowRequest

  workflows.proto:16

  • optional CreateWorkflowVersionOpts opts = 1

• rpc ScheduleWorkflow (ScheduleWorkflowRequest, WorkflowVersion)

  workflows.proto:10

  message ScheduleWorkflowRequest

  workflows.proto:135

  • string name = 1

  • repeated google.protobuf.Timestamp schedules = 2

  • string input = 3

    (optional) the input data for the workflow

  • optional string parent_id = 4

    (optional) the parent workflow run id

  • optional string parent_step_run_id = 5

    (optional) the parent step run id

  • optional int32 child_index = 6

    (optional) the index of the child workflow. if this is set, matches on the index or the child key will be a no-op, even if the schedule has changed.

  • optional string child_key = 7

    (optional) the key for the child. if this is set, matches on the index or the child key will be a no-op, even if the schedule has changed.

  • optional string additional_metadata = 8

    (optional) the additional metadata for the workflow

  • optional int32 priority = 9

    (optional) the priority of the workflow

• rpc TriggerWorkflow (TriggerWorkflowRequest, TriggerWorkflowResponse)

  workflows.proto:11

  message TriggerWorkflowResponse

  workflows.proto:235

  • string workflow_run_id = 1

Used as response type in: Dispatcher.SendGroupKeyActionEvent, Dispatcher.SendStepActionEvent

• string tenantId = 1

  the tenant id

• string workerId = 2

  the id of the worker

Used in: AssignedAction

• START_STEP_RUN = 0

• CANCEL_STEP_RUN = 1

• START_GET_GROUP_KEY = 2

Used as response type in: Dispatcher.Listen, Dispatcher.ListenV2

• string tenantId = 1

  the tenant id

• string workflowRunId = 2

  the workflow run id (optional)

• string getGroupKeyRunId = 3

  the get group key run id (optional)

• string jobId = 4

  the job id

• string jobName = 5

  the job name

• string jobRunId = 6

  the job run id

• string stepId = 7

  the step id

• string stepRunId = 8

  the step run id

• string actionId = 9

  the action id

• ActionType actionType = 10

  the action type

• string actionPayload = 11

  the action payload

• string stepName = 12

  the step name

• int32 retryCount = 13

  the count number of the retry attempt

• optional string additional_metadata = 14

  (optional) additional metadata set on the workflow

• optional int32 child_workflow_index = 15

  (optional) the child workflow index (if this is a child workflow)

• optional string child_workflow_key = 16

  (optional) the child workflow key (if this is a child workflow)

• optional string parent_workflow_run_id = 17

  (optional) the parent workflow run id (if this is a child workflow)

• int32 priority = 18

  (optional) the priority of the run

• optional string workflowId = 19

  (optional) the workflow id

• optional string workflowVersionId = 20

  (optional) the workflow version id

Used in: WorkflowConcurrencyOpts

• CANCEL_IN_PROGRESS = 0

• DROP_NEWEST = 1

  deprecated

• QUEUE_NEWEST = 2

  deprecated

• GROUP_ROUND_ROBIN = 3

• CANCEL_NEWEST = 4

Used in: CreateWorkflowStepOpts

• string key = 1

  (required) the key for the rate limit

• optional int32 units = 2

  (optional) the number of units this step consumes

• optional string key_expr = 3

  (optional) a CEL expression for determining the rate limit key

• optional string units_expr = 4

  (optional) a CEL expression for determining the number of units consumed

• optional string limit_values_expr = 5

  (optional) a CEL expression for determining the total amount of rate limit units

• optional RateLimitDuration duration = 6

  (optional) the default rate limit window to use for dynamic rate limits

CreateWorkflowJobOpts represents options to create a workflow job.

Used in: CreateWorkflowVersionOpts

• string name = 1

  (required) the job name

• string description = 2

  (optional) the job description

• repeated CreateWorkflowStepOpts steps = 4

  (required) the job steps

CreateWorkflowStepOpts represents options to create a workflow step.

Used in: CreateWorkflowJobOpts

• string readable_id = 1

  (required) the step name

• string action = 2

  (required) the step action id

• string timeout = 3

  (optional) the step timeout

• string inputs = 4

  (optional) the step inputs, assuming string representation of JSON

• repeated string parents = 5

  (optional) the step parents. if none are passed in, this is a root step

• string user_data = 6

  (optional) the custom step user data, assuming string representation of JSON

• int32 retries = 7

  (optional) the number of retries for the step, default 0

• repeated CreateStepRateLimit rate_limits = 8

  (optional) the rate limits for the step

• map<string, DesiredWorkerLabels> worker_labels = 9

  (optional) the desired worker affinity state for the step

• optional float backoff_factor = 10

  (optional) the retry backoff factor for the step

• optional int32 backoff_max_seconds = 11

  (optional) the maximum backoff time for the step

CreateWorkflowVersionOpts represents options to create a workflow version.

Used in: PutWorkflowRequest

• string name = 1

  (required) the workflow name

• string description = 2

  (optional) the workflow description

• string version = 3

  (required) the workflow version

• repeated string event_triggers = 4

  (optional) event triggers for the workflow

• repeated string cron_triggers = 5

  (optional) cron triggers for the workflow

• repeated google.protobuf.Timestamp scheduled_triggers = 6

  (optional) scheduled triggers for the workflow

• repeated CreateWorkflowJobOpts jobs = 7

  (required) the workflow jobs

• optional WorkflowConcurrencyOpts concurrency = 8

  (optional) the workflow concurrency options

• optional string schedule_timeout = 9

  (optional) the timeout for the schedule

• optional string cron_input = 10

  (optional) the input for the cron trigger

• optional CreateWorkflowJobOpts on_failure_job = 11

  (optional) the job to run on failure

• optional StickyStrategy sticky = 12

  (optional) the sticky strategy for assigning steps to workers

• optional WorkflowKind kind = 13

  (optional) the kind of workflow

• optional int32 default_priority = 14

  (optional) the priority of the workflow

Used in: CreateWorkflowStepOpts

• optional string strValue = 1

  value of the affinity

• optional int32 intValue = 2

• optional bool required = 3

  * (optional) Specifies whether the affinity setting is required. If required, the worker will not accept actions that do not have a truthy affinity setting. Defaults to false.

• optional WorkerLabelComparator comparator = 4

  * (optional) Specifies the comparator for the affinity setting. If not set, the default is EQUAL.

• optional int32 weight = 5

  * (optional) Specifies the weight of the affinity setting. If not set, the default is 100.

Used as response type in: EventsService.Push, EventsService.ReplaySingleEvent

Used as field type in: Events

• string tenantId = 1

  the tenant id

• string eventId = 2

  the id of the event

• string key = 3

  the key for the event

• string payload = 4

  the payload for the event

• optional google.protobuf.Timestamp eventTimestamp = 5

  when the event was generated

• optional string additionalMetadata = 6

  the additional metadata for the event

• optional string scope = 7

  the scope associated with this filter. Used for subsetting candidate filters at evaluation time

Used in: GroupKeyActionEvent

• GROUP_KEY_EVENT_TYPE_UNKNOWN = 0

• GROUP_KEY_EVENT_TYPE_STARTED = 1

• GROUP_KEY_EVENT_TYPE_COMPLETED = 2

• GROUP_KEY_EVENT_TYPE_FAILED = 3

ListWorkflowsRequest is the request for ListWorkflows.

(message has no fields)

Used as request type in: EventsService.Push

Used as field type in: BulkPushEventRequest

• string key = 1

  the key for the event

• string payload = 2

  the payload for the event

• optional google.protobuf.Timestamp eventTimestamp = 3

  when the event was generated

• optional string additionalMetadata = 4

  metadata for the event

• optional int32 priority = 5

• optional string scope = 6

  the scope associated with this filter. Used for subsetting candidate filters at evaluation time

Used in: CreateStepRateLimit, PutRateLimitRequest

• SECOND = 0

• MINUTE = 1

• HOUR = 2

• DAY = 3

• WEEK = 4

• MONTH = 5

• YEAR = 6

Used in: WorkflowEvent

• RESOURCE_EVENT_TYPE_UNKNOWN = 0

• RESOURCE_EVENT_TYPE_STARTED = 1

• RESOURCE_EVENT_TYPE_COMPLETED = 2

• RESOURCE_EVENT_TYPE_FAILED = 3

• RESOURCE_EVENT_TYPE_CANCELLED = 4

• RESOURCE_EVENT_TYPE_TIMED_OUT = 5

• RESOURCE_EVENT_TYPE_STREAM = 6

Used in: WorkflowEvent

• RESOURCE_TYPE_UNKNOWN = 0

• RESOURCE_TYPE_STEP_RUN = 1

• RESOURCE_TYPE_WORKFLOW_RUN = 2

Used in: WorkerRegisterRequest

• optional string sdkVersion = 1

• optional SDKS language = 2

• optional string languageVersion = 3

• optional string os = 4

• optional string extra = 5

Used in: RuntimeInfo

• UNKNOWN = 0

• GO = 1

• PYTHON = 2

• TYPESCRIPT = 3

ScheduledWorkflow represents a scheduled workflow.

Used in: WorkflowVersion

• string id = 1

• optional google.protobuf.Timestamp trigger_at = 2

Used in: StepActionEvent

• STEP_EVENT_TYPE_UNKNOWN = 0

• STEP_EVENT_TYPE_STARTED = 1

• STEP_EVENT_TYPE_COMPLETED = 2

• STEP_EVENT_TYPE_FAILED = 3

• STEP_EVENT_TYPE_ACKNOWLEDGED = 4

Used in: WorkflowRunEvent

• string stepRunId = 1

• string stepReadableId = 2

• string jobRunId = 3

• optional string error = 4

• optional string output = 5

Used in: CreateWorkflowVersionOpts

• SOFT = 0

• HARD = 1

Used as request type in: WorkflowService.TriggerWorkflow

Used as field type in: BulkTriggerWorkflowRequest

• string name = 1

• string input = 2

  (optional) the input data for the workflow

• optional string parent_id = 3

  (optional) the parent workflow run id

• optional string parent_step_run_id = 4

  (optional) the parent step run id

• optional int32 child_index = 5

  (optional) the index of the child workflow. if this is set, matches on the index or the child key will return an existing workflow run if the parent id, parent step run id, and child index/key match an existing workflow run.

• optional string child_key = 6

  (optional) the key for the child. if this is set, matches on the index or the child key will return an existing workflow run if the parent id, parent step run id, and child index/key match an existing workflow run.

• optional string additional_metadata = 7

  (optional) additional metadata for the workflow

• optional string desired_worker_id = 8

  (optional) desired worker id for the workflow run, requires the workflow definition to have a sticky strategy

• optional int32 priority = 9

  (optional) override for the priority of the workflow steps, will set all steps to this priority

Used in: DesiredWorkerLabels

• EQUAL = 0

• NOT_EQUAL = 1

• GREATER_THAN = 2

• GREATER_THAN_OR_EQUAL = 3

• LESS_THAN = 4

• LESS_THAN_OR_EQUAL = 5

Used in: UpsertWorkerLabelsRequest, WorkerRegisterRequest

• optional string strValue = 1

  value of the label

• optional int32 intValue = 2

Used as request type in: Dispatcher.Listen, Dispatcher.ListenV2

• string workerId = 1

  the id of the worker

Used in: CreateWorkflowVersionOpts

• optional string action = 1

  (optional) the action id for getting the concurrency group

• optional int32 max_runs = 2

  (optional) the maximum number of concurrent workflow runs, default 1

• optional ConcurrencyLimitStrategy limit_strategy = 3

  (optional) the strategy to use when the concurrency limit is reached, default CANCEL_IN_PROGRESS

• optional string expression = 4

  (optional) the expression to use for concurrency

Used in: CreateWorkflowVersionOpts

• FUNCTION = 0

• DURABLE = 1

• DAG = 2

Used in: WorkflowRunEvent

• WORKFLOW_RUN_EVENT_TYPE_FINISHED = 0

WorkflowTriggerCronRef represents the WorkflowTriggerCronRef model.

• string parent_id = 1

• string cron = 2

WorkflowTriggerEventRef represents the WorkflowTriggerEventRef model.

• string parent_id = 1

• string event_key = 2

WorkflowVersion represents the WorkflowVersion model.

Used as response type in: WorkflowService.PutWorkflow, WorkflowService.ScheduleWorkflow

• string id = 1

• optional google.protobuf.Timestamp created_at = 2

• optional google.protobuf.Timestamp updated_at = 3

• string version = 5

• int64 order = 6

• string workflow_id = 7

• repeated ScheduledWorkflow scheduled_workflows = 8