package v1

Get desktop application:
View/edit binary Protocol Buffers messages

AdminService represents a set of RPCs for admin management of tasks, workflows, etc.

• rpc BranchDurableTask (BranchDurableTaskRequest, BranchDurableTaskResponse)

  workflows.proto:18

  message BranchDurableTaskRequest

  workflows.proto:59

  • string task_external_id = 1

    (required) the external id (uuid) of the durable task

  • int64 node_id = 2

    (required) the node id to branch from

  • int64 branch_id = 3

    (required) the branch id to branch from

  message BranchDurableTaskResponse

  workflows.proto:65

  • string task_external_id = 1

    the external id of the durable task

  • int64 node_id = 2

    the node id of the new entry

  • int64 branch_id = 3

    the branch id of the new entry

• rpc CancelTasks (CancelTasksRequest, CancelTasksResponse)

  workflows.proto:14

  message CancelTasksRequest

  workflows.proto:21

  • repeated string external_ids = 1

    a list of external UUIDs

  • optional TasksFilter filter = 2

  message CancelTasksResponse

  workflows.proto:39

  • repeated string cancelled_tasks = 1

• rpc GetRunDetails (GetRunDetailsRequest, GetRunDetailsResponse)

  workflows.proto:17

  message GetRunDetailsRequest

  workflows.proto:172

  • string external_id = 1

    (required) the external id (uuid) of the workflow run

  message GetRunDetailsResponse

  workflows.proto:185

  • bytes input = 1

    the input payload for the workflow run

  • RunStatus status = 2

    the status of the workflow run

  • map<string, TaskRunDetail> task_runs = 3

    map of task run external ids to their details

  • bool done = 4

    indicates if the workflow run is done

  • bytes additional_metadata = 5

    (optional) additional metadata for the workflow run

  • bool is_evicted = 6

    whether any task in this run has been evicted

• rpc PutWorkflow (CreateWorkflowVersionRequest, CreateWorkflowVersionResponse)

  workflows.proto:13

  message CreateWorkflowVersionRequest

  workflows.proto:97

  CreateWorkflowVersionRequest represents options to create a workflow version.

  • string name = 1

    (required) the workflow name

  • string description = 2

    (optional) the workflow description

  • string version = 3

    (optional) 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 CreateTaskOpts tasks = 6

    (required) the workflow jobs

  • optional Concurrency concurrency = 7

    Deprecated: use concurrency_arr instead

    (optional) the workflow concurrency options

  • optional string cron_input = 8

    (optional) the input for the cron trigger

  • optional CreateTaskOpts on_failure_task = 9

    (optional) the job to run on failure

  • optional StickyStrategy sticky = 10

    (optional) the sticky strategy for assigning tasks to workers

  • optional int32 default_priority = 11

    (optional) the default priority for the workflow

  • repeated Concurrency concurrency_arr = 12

    (optional) the workflow concurrency options

  • repeated DefaultFilter default_filters = 13

    (optional) the default filters for the workflow

  • optional bytes input_json_schema = 14

    (optional) the JSON schema for the workflow input

  message CreateWorkflowVersionResponse

  workflows.proto:167

  CreateWorkflowVersionResponse represents the response after creating a workflow version.

  • string id = 1

  • string workflow_id = 2

• rpc ReplayTasks (ReplayTasksRequest, ReplayTasksResponse)

  workflows.proto:15

  message ReplayTasksRequest

  workflows.proto:26

  • repeated string external_ids = 1

    a list of external UUIDs

  • optional TasksFilter filter = 2

  message ReplayTasksResponse

  workflows.proto:43

  • repeated string replayed_tasks = 1

• rpc TriggerWorkflowRun (TriggerWorkflowRunRequest, TriggerWorkflowRunResponse)

  workflows.proto:16

  message TriggerWorkflowRunRequest

  workflows.proto:47

  • string workflow_name = 1

  • bytes input = 2

  • bytes additional_metadata = 3

  • optional int32 priority = 4

  • map<string, DesiredWorkerLabels> desired_worker_labels = 5

  message TriggerWorkflowRunResponse

  workflows.proto:55

  • string external_id = 1

• rpc DurableTask (stream DurableTaskRequest, stream DurableTaskResponse)

  dispatcher.proto:11

  message DurableTaskRequest

  dispatcher.proto:143

  • oneof message

    • DurableTaskRequestRegisterWorker register_worker = 1

    • DurableTaskMemoRequest memo = 2

    • DurableTaskTriggerRunsRequest trigger_runs = 3

    • DurableTaskWaitForRequest wait_for = 4

    • DurableTaskEvictInvocationRequest evict_invocation = 5

    • DurableTaskWorkerStatusRequest worker_status = 6

    • DurableTaskCompleteMemoRequest complete_memo = 7

  message DurableTaskResponse

  dispatcher.proto:166

  • oneof message

    • DurableTaskResponseRegisterWorker register_worker = 1

    • DurableTaskEventMemoAckResponse memo_ack = 2

    • DurableTaskEventTriggerRunsAckResponse trigger_runs_ack = 3

    • DurableTaskEventWaitForAckResponse wait_for_ack = 4

    • DurableTaskEventLogEntryCompletedResponse entry_completed = 5

    • DurableTaskErrorResponse error = 6

    • DurableTaskEvictionAckResponse eviction_ack = 7

    • DurableTaskServerEvictNotice server_evict = 8

• rpc ListenForDurableEvent (stream ListenForDurableEventRequest, stream DurableEvent)

  dispatcher.proto:15

  message ListenForDurableEventRequest

  dispatcher.proto:188

  • string task_id = 1

    single listener per worker

  • string signal_key = 2

    the match id for the listener

  message DurableEvent

  dispatcher.proto:193

  • string task_id = 1

  • string signal_key = 2

  • bytes data = 3

    the data for the event

• rpc RegisterDurableEvent (RegisterDurableEventRequest, RegisterDurableEventResponse)

  dispatcher.proto:14

  NOTE: deprecated after DurableEventLog is implemented

  message RegisterDurableEventRequest

  dispatcher.proto:179

  • string task_id = 1

    external uuid for the task run

  • string signal_key = 2

    the signal key for the event

  • optional DurableEventListenerConditions conditions = 3

    the task conditions for creating the task

  message RegisterDurableEventResponse

  dispatcher.proto:185

  (message has no fields)

Used in: BaseMatchCondition

• CREATE = 0

• QUEUE = 1

• CANCEL = 2

• SKIP = 3

Used in: ParentOverrideMatchCondition, SleepMatchCondition, UserEventMatchCondition

• string readable_data_key = 1

• Action action = 2

• string or_group_id = 3

  a UUID defining the OR group for this condition

• string expression = 4

Used in: CreateTaskOpts, CreateWorkflowVersionRequest

• string expression = 1

  (required) the expression to use for concurrency

• 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

Used in: Concurrency

• CANCEL_IN_PROGRESS = 0

• DROP_NEWEST = 1

  deprecated

• QUEUE_NEWEST = 2

  deprecated

• GROUP_ROUND_ROBIN = 3

• CANCEL_NEWEST = 4

CreateTaskOpts represents options to create a task.

Used in: CreateWorkflowVersionRequest

• 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

• int32 retries = 6

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

• repeated CreateTaskRateLimit rate_limits = 7

  (optional) the rate limits for the task

• map<string, DesiredWorkerLabels> worker_labels = 8

  (optional) the desired worker affinity state for the task

• optional float backoff_factor = 9

  (optional) the retry backoff factor for the task

• optional int32 backoff_max_seconds = 10

  (optional) the maximum backoff time for the task

• repeated Concurrency concurrency = 11

  (optional) the task concurrency options

• optional TaskConditions conditions = 12

  (optional) the task conditions for creating the task

• optional string schedule_timeout = 13

  (optional) the timeout for the schedule

• bool is_durable = 14

  (optional) whether the task is durable

• map<string, int32> slot_requests = 15

  (optional) slot requests (slot_type -> units)

Used in: CreateTaskOpts

• 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

Used in: CreateWorkflowVersionRequest

• string expression = 1

  (required) the CEL expression for the filter

• string scope = 2

  (required) the scope of the filter

• optional bytes payload = 3

  (optional) the payload for the filter, if any. A JSON object as a string.

Used in: CreateWorkflowStepOpts, CreateTaskOpts, TriggerWorkflowRequest, TriggerWorkflowRunRequest

• optional string str_value = 1

  value of the affinity

• optional int32 int_value = 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 in: DurableTaskWaitForRequest, RegisterDurableEventRequest

• repeated SleepMatchCondition sleep_conditions = 1

• repeated UserEventMatchCondition user_event_conditions = 2

Used in: DurableTaskCompleteMemoRequest, DurableTaskErrorResponse, DurableTaskEventLogEntryCompletedResponse, DurableTaskEventMemoAckResponse, DurableTaskEventWaitForAckResponse

• string durable_task_external_id = 1

• int32 invocation_count = 2

• int64 branch_id = 3

• int64 node_id = 4

Used in: DurableTaskWorkerStatusRequest

• string durable_task_external_id = 1

• int64 branch_id = 2

• int64 node_id = 3

• int32 invocation_count = 4

Used in: DurableTaskRequest

• optional DurableEventLogEntryRef ref = 1

• bytes payload = 2

• bytes memo_key = 3

Used in: DurableTaskResponse

• optional DurableEventLogEntryRef ref = 1

• DurableTaskErrorType error_type = 2

• string error_message = 3

Used in: DurableTaskErrorResponse

• DURABLE_TASK_ERROR_TYPE_UNSPECIFIED = 0

• DURABLE_TASK_ERROR_TYPE_NONDETERMINISM = 1

Used in: DurableTaskResponse

• optional DurableEventLogEntryRef ref = 1

• bytes payload = 2

• bool is_failure = 3

• optional string error_message = 4

Used in: DurableTaskResponse

• optional DurableEventLogEntryRef ref = 1

• bool memo_already_existed = 2

• optional bytes memo_result_payload = 3

Used in: DurableTaskResponse

• string durable_task_external_id = 1

• int32 invocation_count = 2

• repeated DurableTaskRunAckEntry run_entries = 3

Used in: DurableTaskResponse

• optional DurableEventLogEntryRef ref = 1

Used in: DurableTaskRequest

• int32 invocation_count = 1

• string durable_task_external_id = 2

• optional string reason = 3

Sent by the server after recording eviction for an evict_invocation request.

Used in: DurableTaskResponse

• int32 invocation_count = 1

• string durable_task_external_id = 2

Used in: DurableTaskRequest

• int32 invocation_count = 1

  The invocation_count is a monotonically increasing count that uniquely identifies an "attempt" at running a durable task. Each time the task is started, it gets a new invocation count (which has) incremented by one since the previous invocation. This allows the server (and the worker) to have a way of differentiating between different attempts of the same task running in different places, to prevent race conditions and other problems from duplication. It also allows for older invocations to be evicted cleanly

• string durable_task_external_id = 2

• bytes key = 3

• optional bytes payload = 4

  optional payload because we can send a memo request to check if a memo already exists

Used in: DurableTaskRequest

• string worker_id = 1

Used in: DurableTaskResponse

• string worker_id = 1

Used in: DurableTaskEventTriggerRunsAckResponse

• int64 node_id = 1

• int64 branch_id = 2

• string workflow_run_external_id = 3

Sent by the server to notify a worker that its invocation is stale and should be cancelled.

Used in: DurableTaskResponse

• string durable_task_external_id = 1

• int32 invocation_count = 2

• string reason = 3

Used in: DurableTaskRequest

• int32 invocation_count = 1

  The invocation_count is a monotonically increasing count that uniquely identifies an "attempt" at running a durable task. Each time the task is started, it gets a new invocation count (which has) incremented by one since the previous invocation. This allows the server (and the worker) to have a way of differentiating between different attempts of the same task running in different places, to prevent race conditions and other problems from duplication. It also allows for older invocations to be evicted cleanly

• string durable_task_external_id = 2

• repeated TriggerWorkflowRequest trigger_opts = 3

Used in: DurableTaskRequest

• int32 invocation_count = 1

  The invocation_count is a monotonically increasing count that uniquely identifies an "attempt" at running a durable task. Each time the task is started, it gets a new invocation count (which has) incremented by one since the previous invocation. This allows the server (and the worker) to have a way of differentiating between different attempts of the same task running in different places, to prevent race conditions and other problems from duplication. It also allows for older invocations to be evicted cleanly

• string durable_task_external_id = 2

• optional DurableEventListenerConditions wait_for_conditions = 3

  Fields for DURABLE_TASK_TRIGGER_KIND_WAIT_FOR

• optional string label = 4

  An optional human-readable label for this wait, displayed in the dashboard. Example: "Waiting for payment confirmation"

Used in: DurableTaskRequest

• string worker_id = 1

• repeated DurableTaskAwaitedCompletedEntry waiting_entries = 2

Used in: TaskConditions

• optional BaseMatchCondition base = 1

• string parent_readable_id = 2

Used in: CreateTaskRateLimit

• SECOND = 0

• MINUTE = 1

• HOUR = 2

• DAY = 3

• WEEK = 4

• MONTH = 5

• YEAR = 6

Used in: GetRunDetailsResponse, TaskRunDetail

• QUEUED = 0

• RUNNING = 1

• COMPLETED = 2

• FAILED = 3

• CANCELLED = 4

• EVICTED = 5

Used in: DurableEventListenerConditions, TaskConditions

• optional BaseMatchCondition base = 1

• string sleep_for = 2

  a duration string indicating how long to sleep

Used in: CreateWorkflowVersionRequest

• SOFT = 0

• HARD = 1

Used in: CreateTaskOpts

• repeated ParentOverrideMatchCondition parent_override_conditions = 1

• repeated SleepMatchCondition sleep_conditions = 2

• repeated UserEventMatchCondition user_event_conditions = 3

Used in: GetRunDetailsResponse

• string external_id = 1

  the external id (uuid) of the task run

• RunStatus status = 2

  the status of the task run

• optional string error = 3

  (optional) error message from the task run, if any

• optional bytes output = 4

  (optional) the output payload for the task run

• string readable_id = 5

  the readable id of the task

• bool is_evicted = 6

  whether the task has been evicted from a worker (status will be RUNNING)

Used in: CancelTasksRequest, ReplayTasksRequest

• repeated string statuses = 1

• optional google.protobuf.Timestamp since = 2

• optional google.protobuf.Timestamp until = 3

• repeated string workflow_ids = 4

• repeated string additional_metadata = 5

Used as request type in: WorkflowService.TriggerWorkflow

Used as field type in: BulkTriggerWorkflowRequest, DurableTaskTriggerRunsRequest

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

  (optional) the parent task external 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 task 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 task 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 tasks, will set all tasks to this priority

• map<string, DesiredWorkerLabels> desired_worker_labels = 10

  (optional) the desired worker labels for the workflow run, which will be used to determine which workers can pick up the workflow's tasks. if not set, defaults to an empty set of labels, which means any worker can pick up the tasks.

Used in: DurableEventListenerConditions, TaskConditions

• optional BaseMatchCondition base = 1

• string user_event_key = 2

• optional string event_scope = 3

  an optional scope for the user event condition (similar to scopes on event filters)

• optional google.protobuf.Timestamp consider_events_since = 4

Used in: DesiredWorkerLabels

• EQUAL = 0

• NOT_EQUAL = 1

• GREATER_THAN = 2

• GREATER_THAN_OR_EQUAL = 3

• LESS_THAN = 4

• LESS_THAN_OR_EQUAL = 5