Expand description
Generated Dex protocol.
Modules§
- admin_
service_ client - Generated client implementations.
- admin_
service_ server - Generated server implementations.
- flow_
history_ event - Nested message and enum types in
FlowHistoryEvent. - flow_
service_ client - Generated client implementations.
- flow_
service_ server - Generated server implementations.
- flow_
started_ or_ continued_ history_ event - Nested message and enum types in
FlowStartedOrContinuedHistoryEvent. - invoke_
execute_ method_ output - Nested message and enum types in
InvokeExecuteMethodOutput. - invoke_
wait_ for_ method_ output - Nested message and enum types in
InvokeWaitForMethodOutput. - poll_
worker_ task - Nested message and enum types in
PollWorkerTask. - poll_
worker_ task_ frame - Nested message and enum types in
PollWorkerTaskFrame. - poll_
worker_ task_ request - Nested message and enum types in
PollWorkerTaskRequest. - poll_
worker_ task_ response - Nested message and enum types in
PollWorkerTaskResponse. - step_
down_ active_ node_ response - Nested message and enum types in
StepDownActiveNodeResponse. - value
- Nested message and enum types in
Value. - worker_
service_ client - Generated client implementations.
- worker_
service_ server - Generated server implementations.
- worker_
task_ service_ client - Generated client implementations.
- worker_
task_ service_ server - Generated server implementations.
Structs§
- Action
Permission Mapping - Action
Permission Mappings - Active
Step Execution State - Attribute
Match - Attribute
Store Names - Attribute
Sync Config - Attribute
Sync Item - Attribute
Write - Channel
Condition - Channel
External Delete Event - Channel
External Publish Event - Channel
Info - Channel
Message - Channel
Message Deletion - Channel
Result - Channel
Values - Close
Decision - Condition
Combination - Condition
Results - Context
- Delete
Channel Message Request - Describe
Active Node Request - Requests the identity of the active Server process that receives the call.
- Describe
Active Node Response - Identifies the active Server process of a node ID.
- Encoded
Object - Flow
Already Started Options - Flow
Closed History Event - Flow
Config - Flow
Continued Start - Deprecated: Dex does not continue Flows as new and never records this start.
- Flow
Execution Id - Flow
History Event - Flow
Initial Start - Flow
Result - Flow
Retry Policy - Dex does not support Flow retry and rejects a set policy with INVALID_ARGUMENT.
- Flow
Start Options - Flow
Started OrContinued History Event - Flow
Timeout Handler Options - GetAttributes
Request - GetAttributes
Response - GetChannel
Messages Request - GetChannel
Messages Response - GetFlow
State Request - GetFlow
State Response - GetFlow
Summary Request - GetFlow
Summary Response - GetHistory
Events Request - GetHistory
Events Response - Health
Info - History
Event IdRange - HistoryEventIDRange is an inclusive range of history event IDs of one run.
- Index
Config - Invoke
Execute Method Output - Invoke
Execute Method Request - Invoke
Execute Method Response - Invoke
RpcRequest - Invoke
RpcResponse - Invoke
Wait ForMethod Output - Invoke
Wait ForMethod Request - Invoke
Wait ForMethod Response - Invoke
Worker RpcRequest - Invoke
Worker RpcResponse - Kv
- List
Stream Messages Request - List
Stream Messages Response - Load
Blob Request Entry - Load
Blobs Request - Load
Blobs Response - Node
Lease Holder - Identifies the process that holds a node lease.
- Node
Lease Holder Unknown - Says why the stepped-down process could not confirm which process holds the node lease.
- Poll
Worker Task - Assigns one task to this stream until its final result, error, or rejection.
- Poll
Worker Task Cancel Task - Requests cancellation of the task currently assigned to this stream.
- Poll
Worker Task Frame - Carries a task’s heartbeat, stream write, result, or Worker error.
- Poll
Worker Task Ping - Checks that an idle pull stream remains responsive.
- Poll
Worker Task Pong - Acknowledges a server Ping on the same stream.
- Poll
Worker Task Reconnect - Asks the Worker to finish its task and reconnect for queue or slot ownership changes or shutdown.
- Poll
Worker Task Register - Registers one queue stream or reserved execution slot for a Worker process.
- Poll
Worker Task Registered - Confirms that Dex accepted the queue or reserved-slot registration.
- Poll
Worker Task Reject - Declines a task so Dex can assign it to another available Worker stream. Reserved-slot streams may send only UNKNOWN_STEP or UNKNOWN_RPC; the handler never ran. NO_CAPACITY on a reserved-slot stream is a protocol error. Dex then fails that attempt as not run, which consumes an attempt, and ends the stream with INVALID_ARGUMENT.
- Poll
Worker Task Request - Carries one Worker frame on a pull stream. Register must be the first frame.
- Poll
Worker Task Response - Carries one server frame on a pull stream.
- Publish
ToChannel Request - Pull
Routing - Read
Stream Request - Read
Stream Response - Recovery
Error Info - Describes a Step method failure for its recovery path.
- Reset
Flow Request - Reset
Flow Response - Retry
Policy - RpcExecution
Completed Event - Successful RPC history projection. Transactional RPCs include input/output; other RPCs omit them.
- Search
Flows Request - Search
Flows Response - Search
Flows Response Entry - Server
Info - Describes the Dex Server release and the inclusive protocol range it supports.
- Service
Error Response - SetAttributes
Request - Skip
Timer Request - Start
Flow Request - Start
Flow Response - Step
Completion Output - Step
Decision - Step
Down Active Node Request - Requests a step down of the active Server process that receives the call.
- Step
Down Active Node Response - Reports a completed step down and which process held the node lease when the call returned.
- Step
Execute Completed Event - Step
Execute Completed Output - Step
Execute Failed Event - Step
Execution Completed Conditions - Step
Execution Resume Info - Step
Method Event Context - Step
Method Event Input - Step
Method Failed Output - Step
Method Failure - Step
Method Heartbeat - Step
Method Invocation State - The current invocation of one Step method: its phase, its attempt, and why a pending attempt waits.
- Step
Method Options - Step
Method Pending Event - StepMethodPendingEvent describes a regular Step method unresolved at flow closure.
- Step
Movement - Step
Options - Step
Stream Write - Step
Wait ForCompleted Event - Step
Wait ForCompleted Output - Step
Wait ForFailed Event - Stop
Flow Request - Stream
Message - SubFlow
Condition - SubFlow
Condition State - SubFlow
Options - Sync
Attribute Index Request - Sync
Attribute Index Response - Time
Travel Fork History Event - TimeTravelForkHistoryEvent identifies the preserved run whose history Time Travel forked.
- Timer
Condition - Timer
Info - Timer
Result - Trigger
Continue AsNew Request - Deprecated: TriggerContinueAsNew always returns UNIMPLEMENTED.
- Update
Flow Config Request - Value
- Wait
ForAttribute Request - Wait
ForAttribute Response - Wait
ForFlow Request - Wait
ForHistory Event Request - Wait
ForHistory Event Response - Wait
ForStep Completion Request - Wait
ForStep Completion Response - Waiting
Condition - Waiting
Condition State - Worker
Error Response - Worker
Target - Write
Stream Request
Enums§
- Active
Step Phase - Active
Step Search Mode - Attribute
Match Operator - Close
Decision Type - Condition
Status - Dispatch
Task Error Reason - Distinguishes no available Worker, a disconnected Worker, and a missing Step or RPC registration. Dex persists it in Step method failure events.
- Error
SubStatus - Execute
Method Failure Policy - Flow
Error Type - Flow
Reset Step Method - Flow
Reset Type - Flow
Status - Flow
Timeout Policy - IdReuse
Policy - Index
Type - Internal
Timer Status - Pending
Step Method Phase - PendingStepMethodPhase reports the latest persisted backend lifecycle event. SCHEDULED waits for locks or dispatch. STARTED means an attempt is running.
- Poll
Worker Slot Kind - Selects the tasks accepted by a reserved Worker execution slot.
- Poll
Worker Task Reject Reason - Explains why a Worker declined a task. See PollWorkerTaskReject for the reasons a reserved-slot stream may send.
- Pull
Routing Source - Server
Engine - Identifies the engine behind a Dex Server. Clients use it only to adapt behavior that differs between engines.
- Step
Attempt Progress - Reports the furthest progress across attempts of a Step method call.
- Step
Durability - Was optimize_activity: false=SYNC, true=ASYNC. Timer is always optimized by the server. Both durabilities record the same events. ASYNC advances without waiting for the commit; there is no local phase.
- Step
Method Invocation Phase - Where the current invocation of a Step method stands.
- Step
Method Pending Reason - Why a pending Step method attempt has not reached a Worker yet.
- Stop
Type - SubFlow
Reuse Policy - Wait
ForMethod Failure Policy - Waiting
Condition Type