Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetVersion (GetVersionRequest, GetVersionResponse)

  dispatcher.proto:42

  GetVersion returns the dispatcher protocol version as a simple integer. SDKs use this to determine feature support (e.g. slot_config registration). Old engines that do not implement this RPC will return UNIMPLEMENTED.

  message GetVersionRequest

  dispatcher.proto:435

  (message has no fields)

  message GetVersionResponse

  dispatcher.proto:437

  • string version = 1

• rpc Heartbeat (HeartbeatRequest, HeartbeatResponse)

  dispatcher.proto:17

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

  message HeartbeatRequest

  dispatcher.proto:399

  • string worker_id = 1

    the id of the worker

  • optional google.protobuf.Timestamp heartbeat_at = 2

    heartbeatAt is the time the worker sent the heartbeat

  message HeartbeatResponse

  dispatcher.proto:407

  (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:383

  • string task_run_external_id = 1

    the task run id

  • string path = 2

    the path of the data to set

  • string value = 3

    the value to set

  • string caller_filename = 4

    the filename of the caller

  message OverridesDataResponse

  dispatcher.proto:397

  (message has no fields)

• rpc RefreshTimeout (RefreshTimeoutRequest, RefreshTimeoutResponse)

  dispatcher.proto:31

  message RefreshTimeoutRequest

  dispatcher.proto:409

  • string task_run_external_id = 1

    the id of the task run to release

  • string increment_timeout_by = 2

  message RefreshTimeoutResponse

  dispatcher.proto:416

  • optional google.protobuf.Timestamp timeout_at = 1

• rpc Register (WorkerRegisterRequest, WorkerRegisterResponse)

  dispatcher.proto:8

  message WorkerRegisterRequest

  dispatcher.proto:67

  • string worker_name = 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 slots = 4

    (optional) the number of default slots this worker can handle deprecated: use slot_config instead

  • map<string, WorkerLabels> labels = 5

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

  • optional string webhook_id = 6

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

  • optional RuntimeInfo runtime_info = 7

    (optional) information regarding the runtime environment of the worker

  • map<string, int32> slot_config = 9

    (optional) slot config for this worker (slot_type -> units)

  message WorkerRegisterResponse

  dispatcher.proto:95

  • string tenant_id = 1

    the tenant id

  • string worker_id = 2

    the id of the worker

  • string worker_name = 3

    the name of the worker

• rpc ReleaseSlot (ReleaseSlotRequest, ReleaseSlotResponse)

  dispatcher.proto:33

  message ReleaseSlotRequest

  dispatcher.proto:420

  • string task_run_external_id = 1

    the id of the task run to release

  message ReleaseSlotResponse

  dispatcher.proto:425

  (message has no fields)

• rpc RestoreEvictedTask (RestoreEvictedTaskRequest, RestoreEvictedTaskResponse)

  dispatcher.proto:35

  message RestoreEvictedTaskRequest

  dispatcher.proto:427

  • string task_run_external_id = 1

  message RestoreEvictedTaskResponse

  dispatcher.proto:431

  • bool requeued = 1

• rpc SendGroupKeyActionEvent (GroupKeyActionEvent, ActionEventResponse)

  dispatcher.proto:25

  message GroupKeyActionEvent

  dispatcher.proto:225

  • string worker_id = 1

    the id of the worker

  • string workflow_run_id = 2

    the id of the job

  • string get_group_key_run_id = 3

  • string action_id = 4

    the action id

  • optional google.protobuf.Timestamp event_timestamp = 5

  • GroupKeyActionEventType event_type = 6

    the task event type

  • string event_payload = 7

    the event payload

• rpc SendStepActionEvent (StepActionEvent, ActionEventResponse)

  dispatcher.proto:23

  message StepActionEvent

  dispatcher.proto:254

  • string worker_id = 1

    the id of the worker

  • string job_id = 2

    the id of the job

  • string job_run_id = 3

    the job run id

  • string task_id = 4

    the id of the task

  • string task_run_external_id = 5

    the task external run id

  • string action_id = 6

    the action id

  • optional google.protobuf.Timestamp event_timestamp = 7

  • StepActionEventType event_type = 8

    the task event type

  • string event_payload = 9

    the event payload

  • optional int32 retry_count = 10

    the retry count

  • optional bool should_not_retry = 11

    a flag indicating if the task should _not_ be retried

• rpc SubscribeToWorkflowEvents (SubscribeToWorkflowEventsRequest, stream WorkflowEvent)

  dispatcher.proto:19

  message SubscribeToWorkflowEventsRequest

  dispatcher.proto:296

  • optional string workflow_run_id = 1

    the id of the workflow run

  • optional string additional_meta_key = 2

    the key of the additional meta field to subscribe to

  • optional string additional_meta_value = 3

    the value of the additional meta field to subscribe to

  message WorkflowEvent

  dispatcher.proto:328

  • string workflow_run_id = 1

    the id of the workflow run

  • ResourceType resource_type = 2

  • ResourceEventType event_type = 3

  • string resource_id = 4

  • optional google.protobuf.Timestamp event_timestamp = 5

  • string event_payload = 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 task_retries = 8

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

  • optional int32 retry_count = 9

    (optional) the retry count of this task

  • optional int64 event_index = 10

• rpc SubscribeToWorkflowRuns (stream SubscribeToWorkflowRunsRequest, stream WorkflowRunEvent)

  dispatcher.proto:21

  message SubscribeToWorkflowRunsRequest

  dispatcher.proto:307

  • string workflow_run_id = 1

    the id of the workflow run

  message WorkflowRunEvent

  dispatcher.proto:360

  • string workflow_run_id = 1

    the id of the workflow run

  • WorkflowRunEventType event_type = 2

  • optional google.protobuf.Timestamp event_timestamp = 3

  • repeated StepRunResult results = 4

• rpc Unsubscribe (WorkerUnsubscribeRequest, WorkerUnsubscribeResponse)

  dispatcher.proto:29

  message WorkerUnsubscribeRequest

  dispatcher.proto:205

  • string worker_id = 1

    the id of the worker

  message WorkerUnsubscribeResponse

  dispatcher.proto:210

  • string tenant_id = 1

    the tenant id to unsubscribe from

  • string worker_id = 2

    the id of the worker

• rpc UpsertWorkerLabels (UpsertWorkerLabelsRequest, UpsertWorkerLabelsResponse)

  dispatcher.proto:37

  message UpsertWorkerLabelsRequest

  dispatcher.proto:106

  • string worker_id = 1

    the name of the worker

  • map<string, WorkerLabels> labels = 2

    (optional) the worker labels

  message UpsertWorkerLabelsResponse

  dispatcher.proto:115

  • string tenant_id = 1

    the tenant id

  • string worker_id = 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 task_run_external_id = 1

    the task external run id for the request

  • optional google.protobuf.Timestamp created_at = 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 task_retry_count = 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 task_run_external_id = 1

    the task external run id for the request

  • optional google.protobuf.Timestamp created_at = 2

    when the stream event was created

  • bytes message = 3

    the stream event message

  • string metadata = 5

    associated stream event metadata

  • optional int64 event_index = 6

  message PutStreamEventResponse

  events.proto:85

  (message has no fields)

• rpc ReplaySingleEvent (ReplayEventRequest, Event)

  events.proto:12

  message ReplayEventRequest

  events.proto:112

  • string event_id = 1

    the event id to replay

WorkflowService represents a set of RPCs for managing workflows.

• rpc BulkTriggerWorkflow (BulkTriggerWorkflowRequest, BulkTriggerWorkflowResponse)

  workflows.proto:13

  message BulkTriggerWorkflowRequest

  workflows.proto:160

  • repeated v1.TriggerWorkflowRequest workflows = 1

  message BulkTriggerWorkflowResponse

  workflows.proto:164

  • repeated string workflow_run_ids = 1

• rpc PutRateLimit (PutRateLimitRequest, PutRateLimitResponse)

  workflows.proto:14

  message PutRateLimitRequest

  workflows.proto:182

  • 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:193

  (message has no fields)

• rpc PutWorkflow (PutWorkflowRequest, WorkflowVersion)

  workflows.proto:10

  message PutWorkflowRequest

  workflows.proto:17

  • optional CreateWorkflowVersionOpts opts = 1

• rpc ScheduleWorkflow (ScheduleWorkflowRequest, WorkflowVersion)

  workflows.proto:11

  message ScheduleWorkflowRequest

  workflows.proto:101

  • 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_task_run_external_id = 5

    (optional) the parent task external 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 (v1.TriggerWorkflowRequest, TriggerWorkflowResponse)

  workflows.proto:12

  message TriggerWorkflowResponse

  workflows.proto:168

  • string workflow_run_id = 1

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

• string tenant_id = 1

  the tenant id

• string worker_id = 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 tenant_id = 1

  the tenant id

• string workflow_run_id = 2

  the workflow run id (optional)

• string get_group_key_run_id = 3

  the get group key run id (optional)

• string job_id = 4

  the job id

• string job_name = 5

  the job name

• string job_run_id = 6

  the job run id

• string task_id = 7

  the task id

• string task_run_external_id = 8

  the task external run id

• string action_id = 9

  the action id

• ActionType action_type = 10

  the action type

• string action_payload = 11

  the action payload

• string task_name = 12

  the task name

• int32 retry_count = 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 workflow_id = 19

  (optional) the workflow id

• optional string workflow_version_id = 20

  (optional) the workflow version id

• optional int32 durable_task_invocation_count = 21

  (optional) the invocation count for durable task events (required for durable events, otherwise null)

• optional string triggering_event_external_id = 22

  (optional) the external id of the event that triggered this workflow run (if any)

• optional string triggering_event_key = 23

  (optional) the key of the event that triggered this workflow run (if any)

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 task 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 tasks

CreateWorkflowStepOpts represents options to create a workflow task.

Used in: CreateWorkflowJobOpts

• string readable_id = 1

  (required) the task name

• string action = 2

  (required) the task action id

• string timeout = 3

  (optional) the task timeout

• string inputs = 4

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

• repeated string parents = 5

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

• string user_data = 6

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

• int32 retries = 7

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

• repeated CreateStepRateLimit rate_limits = 8

  (optional) the rate limits for the task

• map<string, v1.DesiredWorkerLabels> worker_labels = 9

  (optional) the desired worker affinity state for the task

• optional float backoff_factor = 10

  (optional) the retry backoff factor for the task

• optional int32 backoff_max_seconds = 11

  (optional) the maximum backoff time for the task

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 tasks to workers

• optional WorkflowKind kind = 13

  (optional) the kind of workflow

• optional int32 default_priority = 14

  (optional) the priority of the workflow

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

Used as field type in: Events

• string tenant_id = 1

  the tenant id

• string event_id = 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 event_timestamp = 5

  when the event was generated

• optional string additional_metadata = 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 event_timestamp = 3

  when the event was generated

• optional string additional_metadata = 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 sdk_version = 1

• optional SDKS language = 2

• optional string language_version = 3

• optional string os = 4

• optional string extra = 5

Used in: RuntimeInfo

• UNKNOWN = 0

• GO = 1

• PYTHON = 2

• TYPESCRIPT = 3

• RUBY = 4

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 task_run_external_id = 1

• string task_name = 2

• string job_run_id = 3

• optional string error = 4

• optional string output = 5

Used in: CreateWorkflowVersionOpts

• SOFT = 0

• HARD = 1

Used in: UpsertWorkerLabelsRequest, WorkerRegisterRequest

• optional string str_value = 1

  value of the label

• optional int32 int_value = 2

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

• string worker_id = 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