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 PutWorkflow (CreateWorkflowVersionRequest, CreateWorkflowVersionResponse)

  workflows.proto:12

  message CreateWorkflowVersionRequest

  workflows.proto:71

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

  • optional int32 default_priority = 11

    (optional) the default priority for the workflow

  • repeated Concurrency concurrency_arr = 12

    (optional) the workflow concurrency options

  message CreateWorkflowVersionResponse

  workflows.proto:164

  CreateWorkflowVersionResponse represents the response after creating a workflow version.

  • string id = 1

  • string workflow_id = 2

• rpc CancelTasks (CancelTasksRequest, CancelTasksResponse)

  workflows.proto:13

  message CancelTasksRequest

  workflows.proto:18

  • repeated string externalIds = 1

    a list of external UUIDs

  • optional TasksFilter filter = 2

  message CancelTasksResponse

  workflows.proto:36

  • repeated string cancelled_tasks = 1

• rpc ReplayTasks (ReplayTasksRequest, ReplayTasksResponse)

  workflows.proto:14

  message ReplayTasksRequest

  workflows.proto:23

  • repeated string externalIds = 1

    a list of external UUIDs

  • optional TasksFilter filter = 2

  message ReplayTasksResponse

  workflows.proto:40

  • repeated string replayed_tasks = 1

• rpc TriggerWorkflowRun (TriggerWorkflowRunRequest, TriggerWorkflowRunResponse)

  workflows.proto:15

  message TriggerWorkflowRunRequest

  workflows.proto:44

  • string workflow_name = 1

  • bytes input = 2

  • bytes additional_metadata = 3

  • optional int32 priority = 4

  message TriggerWorkflowRunResponse

  workflows.proto:51

  • string external_id = 1

• rpc RegisterDurableEvent (RegisterDurableEventRequest, RegisterDurableEventResponse)

  dispatcher.proto:10

  message RegisterDurableEventRequest

  dispatcher.proto:15

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

  (message has no fields)

• rpc ListenForDurableEvent (stream ListenForDurableEventRequest, stream DurableEvent)

  dispatcher.proto:12

  message ListenForDurableEventRequest

  dispatcher.proto:24

  • string task_id = 1

    single listener per worker

  • string signal_key = 2

    the match id for the listener

  message DurableEvent

  dispatcher.proto:29

  • string task_id = 1

  • string signal_key = 2

  • bytes data = 3

    the data for the event

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 step, default 0

• repeated CreateTaskRateLimit rate_limits = 7

  (optional) the rate limits for the step

• map<string, DesiredWorkerLabels> worker_labels = 8

  (optional) the desired worker affinity state for the step

• optional float backoff_factor = 9

  (optional) the retry backoff factor for the step

• optional int32 backoff_max_seconds = 10

  (optional) the maximum backoff time for the step

• 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

Used in: CreateTaskOpts

• 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

Used in: CreateTaskOpts

• 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 in: RegisterDurableEventRequest

• repeated SleepMatchCondition sleep_conditions = 1

• repeated UserEventMatchCondition user_event_conditions = 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: 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: 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 in: DurableEventListenerConditions, TaskConditions

• optional BaseMatchCondition base = 1

• string user_event_key = 2

Used in: DesiredWorkerLabels

• EQUAL = 0

• NOT_EQUAL = 1

• GREATER_THAN = 2

• GREATER_THAN_OR_EQUAL = 3

• LESS_THAN = 4

• LESS_THAN_OR_EQUAL = 5