AwaitWorkflowEventRequest",id:"awaitworkfloweventrequest",level:2},{value:"Required Parameters",id:"required-parameters",level:3},{value:"Examples",id:"examples",level:2},{value:"Awaiting a WorkflowEvent",id:"awaiting-a-workflowevent",level:3},{value:"Awaiting Events from Multiple WorkflowEventDefs",id:"awaiting-events-from-multiple-workfloweventdefs",level:3},{value:"Using Deadlines",id:"using-deadlines",level:3},{value:"Ignoring WorkflowEvents",id:"ignoring-workflowevents",level:3}];function f(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"await-workflow-events",children:"Await Workflow Events"})}),"\n",(0,o.jsxs)(n.p,{children:["You can await a ",(0,o.jsx)(n.code,{children:"WorkflowEvent"})," using the ",(0,o.jsx)(n.code,{children:"AwaitWorkflowEvent"})," RPC call."]}),"\n",(0,o.jsx)(n.h2,{id:"awaitworkfloweventrequest",children:(0,o.jsx)(n.code,{children:"AwaitWorkflowEventRequest"})}),"\n",(0,o.jsxs)(n.p,{children:["You need to create an ",(0,o.jsx)(n.code,{children:"AwaitWorkflowEventRequest"})," to do so. The protobuf definition is:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-protobuf",children:"message AwaitWorkflowEventRequest {\n WfRunId wf_run_id = 1;\n repeated WorkflowEventDefId event_def_ids = 2;\n repeated WorkflowEventId workflow_events_to_ignore = 3;\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"required-parameters",children:"Required Parameters"}),"\n",(0,o.jsx)(n.p,{children:"The three required values are:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"wfRunId"})," is the ID of the ",(0,o.jsx)(n.code,{children:"WfRun"})," that the ",(0,o.jsx)(n.code,{children:"WorkflowEvent"})," is thrown from."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"eventDefIds"})," is a repeated field including the IDs of the ",(0,o.jsx)(n.code,{children:"WorkflowEventDef"}),"s you want to await thrown ",(0,o.jsx)(n.code,{children:"WorkflowEvent"}),"s for. The request will return the first matching ",(0,o.jsx)(n.code,{children:"WorkflowEvent"})," thrown. If this field is empty, the request will return the first ",(0,o.jsx)(n.code,{children:"WorkflowEvent"})," thrown by the ",(0,o.jsx)(n.code,{children:"WfRun"}),"."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"workflowEventsToIgnore"})," is a repeated field of IDs of ",(0,o.jsx)(n.code,{children:"WorkflowEvents"})," that you want to ignore. This gives the client the ability to ignore ",(0,o.jsx)(n.code,{children:"WorkflowEvent"}),"s that have already been awaited. See ",(0,o.jsx)(n.a,{href:"#ignoring-workflowevents",children:"Ignoring WorkflowEvents"})," for an example."]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n","\n",(0,o.jsxs)(n.h3,{id:"awaiting-a-workflowevent",children:["Awaiting a ",(0,o.jsx)(n.code,{children:"WorkflowEvent"})]}),"\n",(0,o.jsxs)(l.A,{children:[(0,o.jsx)(i.A,{value:"java",label:"Java",default:!0,children:(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'WorkflowEvent event = client.awaitWorkflowEvent(AwaitWorkflowEventRequest.newBuilder()\n .setWfRunId(WfRunId.newBuilder().setId("your-workflow-run-id"))\n .addEventDefIds(WorkflowEventDefId.newBuilder().setName("my-workflow-event-def"))\n .build());\n'})})}),(0,o.jsx)(i.A,{value:"python",label:"Python",default:!0,children:(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'async def main() -> None:\n config = get_config()\n client = config.stub()\n\n await_workflow_event_request = AwaitWorkflowEventRequest(\n wf_run_id=WfRunId(id="your-wf-run-id"),\n event_def_ids=[WorkflowEventDefId(name="my-workflow-event-def")],\n workflow_events_to_ignore=None)\n\n client.AwaitWorkflowEvent(await_workflow_event_request)\n'})})}),(0,o.jsx)(i.A,{value:"go",label:"Go",default:!0,children:(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\nevent, err := (*client).AwaitWorkflowEvent(context.Background(),\n &lhproto.AwaitWorkflowEventRequest{\n WfRunId: &lhproto.WfRunId{\n Id: "your-workflow-run-id",\n },\n EventDefIds: []*lhproto.WorkflowEventDefId {\n &lhproto.WorkflowEventDefId{\n Name: "my-workflow-event-def",\n },\n }\n },\n)\n'})})})]}),"\n",(0,o.jsx)("hr",{}),"\n",(0,o.jsxs)(n.h3,{id:"awaiting-events-from-multiple-workfloweventdefs",children:["Awaiting Events from Multiple ",(0,o.jsx)(n.code,{children:"WorkflowEventDef"}),"s"]}),"\n",(0,o.jsxs)(n.p,{children:["In the event your workflow throws multiple types of ",(0,o.jsx)(n.code,{children:"WorkflowEvent"}),"s, you can specify multiple ",(0,o.jsx)(n.code,{children:"WorkflowEventDef"}),"s in your request. The request will return the first matching ",(0,o.jsx)(n.code,{children:"WorkflowEvent"})," thrown by your workflow."]}),"\n",(0,o.jsxs)(l.A,{children:[(0,o.jsx)(i.A,{value:"java",label:"Java",default:!0,children:(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'WorkflowEvent event = client.awaitWorkflowEvent(AwaitWorkflowEventRequest.newBuilder()\n .setWfRunId(WfRunId.newBuilder().setId("your-workflow-run-id"))\n // highlight-start\n .addEventDefIds(WorkflowEventDefId.newBuilder().setName("my-workflow-event-def"))\n .addEventDefIds(WorkflowEventDefId.newBuilder().setName("another-workflow-event-def"))\n // highlight-end\n .build());\n'})})}),(0,o.jsx)(i.A,{value:"python",label:"Python",default:!0,children:(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'async def main() -> None:\n config = get_config()\n client = config.stub()\n\n await_workflow_event_request = AwaitWorkflowEventRequest(\n wf_run_id=WfRunId(id="your-wf-run-id"),\n # highlight-start\n event_def_ids=[WorkflowEventDefId(name="my-workflow-event-def"),\n WorkflowEventDefId(name="another-workflow-event-def")],\n # highlight-end\n workflow_events_to_ignore=None)\n\n event: WorkflowEvent = client.AwaitWorkflowEvent(await_workflow_event_request)\n'})})}),(0,o.jsx)(i.A,{value:"go",label:"Go",default:!0,children:(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\nevent, err := (*client).AwaitWorkflowEvent(context.Background(),\n &lhproto.AwaitWorkflowEventRequest{\n WfRunId: &lhproto.WfRunId{\n Id: "your-workflow-run-id",\n },\n EventDefIds: []*lhproto.WorkflowEventDefId {\n // highlight-start\n &lhproto.WorkflowEventDefId{\n Name: "my-workflow-event-def",\n },\n &lhproto.WorkflowEventDefId{\n Name: "another-workflow-event-def",\n },\n // highlight-end\n }\n },\n)\n'})})})]}),"\n",(0,o.jsx)("hr",{}),"\n",(0,o.jsx)(n.h3,{id:"using-deadlines",children:"Using Deadlines"}),"\n",(0,o.jsxs)(n.p,{children:["Upon the execution of a ",(0,o.jsx)(n.code,{children:"THROW_EVENT"})," node, LittleHorse will always ensure that your ",(0,o.jsx)(n.code,{children:"WorkflowEvent"}),"s are thrown and returned to any clients awaiting them. However, you may still find it useful to set a ",(0,o.jsx)(n.a,{href:"https://grpc.io/docs/guides/deadlines/",children:"gRPC deadline"})," on your ",(0,o.jsx)(n.code,{children:"AwaitWorkflowEvent"})," request in case a ",(0,o.jsx)(n.code,{children:"WorkflowEvent"})," is not thrown within a specified period of time."]}),"\n",(0,o.jsx)(n.admonition,{type:"info",children:(0,o.jsxs)(n.p,{children:["You can configure a gRPC deadline for any LittleHorse Client request, not just ",(0,o.jsx)(n.code,{children:"AwaitWorkflowEvent"}),"! If the request does not complete within the specified time, it will be automatically canceled and return gRPC Status Code 1 ",(0,o.jsx)(n.code,{children:"CANCELLED"}),"."]})}),"\n",(0,o.jsxs)(l.A,{children:[(0,o.jsxs)(i.A,{value:"java",label:"Java",default:!0,children:[(0,o.jsxs)(n.p,{children:["To use deadlines with our Java SDK, you can call the ",(0,o.jsx)(n.code,{children:"LittleHorseBlockingStub#withDeadlineAfter()"})," method before your gRPC request method call."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'Properties props = getConfigProps();\nLHConfig config = new LHConfig(props);\nLittleHorseBlockingStub client = config.getBlockingStub();\n\n// highlight-next-line\nWorkflowEvent event = client.withDeadlineAfter(1000, TimeUnit.MILLISECONDS)\n .awaitWorkflowEvent(AwaitWorkflowEventRequest.newBuilder()\n .setWfRunId(WfRunId.newBuilder().setId("your-workflow-run-id"))\n .build());\n'})}),(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"Parameters"})}),(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"LittleHorseBlockingStub#withDeadlineAfter()"})," method takes two parameters:"]}),(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"long duration"}),": the duration to await the request"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"TimeUnit unit"}),": the unit of time for the duration value"]}),"\n"]})]}),(0,o.jsxs)(i.A,{value:"python",label:"Python",default:!0,children:[(0,o.jsxs)(n.p,{children:["To use deadlines with our Python SDK, you can use the ",(0,o.jsx)(n.code,{children:"timeout"})," parameter in any gRPC request method call."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'async def main() -> None:\n config = get_config()\n client = config.stub()\n\n await_workflow_event_request = AwaitWorkflowEventRequest(\n wf_run_id=WfRunId(id="your-wf-run-id"),\n event_def_ids=[WorkflowEventDefId(name="my-workflow-event-def")],\n workflow_events_to_ignore=None)\n\n # highlight-next-line\n event: WorkflowEvent = client.AwaitWorkflowEvent(await_workflow_event_request, timeout=1)\n'})}),(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"Parameters"})}),(0,o.jsxs)(n.p,{children:["Every ",(0,o.jsx)(n.code,{children:"LittleHorseStub"})," request method features an ",(0,o.jsx)(n.code,{children:"int timeout"})," parameter which represents the amount of time in ",(0,o.jsx)(n.code,{children:"seconds"})," that the client will wait before cancelling your request."]})]}),(0,o.jsxs)(i.A,{value:"go",label:"Go",default:!0,children:[(0,o.jsxs)(n.p,{children:["To use deadlines in our Go SDK, you can use the ",(0,o.jsx)(n.code,{children:"context"})," library's ",(0,o.jsx)(n.code,{children:"withTimeout()"})," method to wrap your context with a fixed deadline."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\n// highlight-start\ncontextWithTimeout, cancel := context.WithTimeout(context.Background(), time.Millisecond*1000)\ndefer cancel() // Ensure that cancel is called to release resources\n// highlight-end\n\nevent, err := (*client).AwaitWorkflowEvent(contextWithTimeout,\n &lhproto.AwaitWorkflowEventRequest{\n WfRunId: &lhproto.WfRunId{\n Id: "your-workflow-run-id",\n },\n EventDefIds: []*lhproto.WorkflowEventDefId {\n &lhproto.WorkflowEventDefId{\n Name: "my-workflow-event-def",\n },\n }\n },\n)\n'})}),(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"Parameters"})}),(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"Context.WithTimeout()"})," method takes two parameters:"]}),(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"parent Context"}),": the context of your request, usually ",(0,o.jsx)(n.code,{children:"context.Background()"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"timeout time.Duration"}),": the unit and duration of time for your deadline"]}),"\n"]}),(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://pkg.go.dev/context#WithTimeout",children:"Context.WithTimeout() Documentation"})})]})]}),"\n",(0,o.jsx)("hr",{}),"\n",(0,o.jsxs)(n.h3,{id:"ignoring-workflowevents",children:["Ignoring ",(0,o.jsx)(n.code,{children:"WorkflowEvent"}),"s"]}),"\n",(0,o.jsxs)(n.p,{children:["Since a single ",(0,o.jsx)(n.code,{children:"WfRun"})," may throw multiple ",(0,o.jsx)(n.code,{children:"WorkflowEvent"}),"s with the same ",(0,o.jsx)(n.code,{children:"WorkflowEventDefId"}),', clients have the ability to "ignore" ',(0,o.jsx)(n.code,{children:"WorkflowEvent"}),"s that have already been awaited. Any ",(0,o.jsx)(n.code,{children:"WorkflowEvent"})," specified within the ",(0,o.jsx)(n.code,{children:"workflowEventsToIgnore"})," field will be ignored."]}),"\n",(0,o.jsxs)(l.A,{children:[(0,o.jsx)(i.A,{value:"java",label:"Java",default:!0,children:(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'// The first WorkflowEvent awaited by the client\nWorkflowEvent event1 = client.awaitWorkflowEvent(AwaitWorkflowEventRequest.newBuilder()\n .setWfRunId(WfRunId.newBuilder().setId("your-workflow-run-id"))\n .addEventDefIds(WorkflowEventDefId.newBuilder().setName("my-workflow-event-def"))\n .build());\n\n// The second WorkflowEvent awaited by the client\nWorkflowEvent event2 = client.awaitWorkflowEvent(AwaitWorkflowEventRequest.newBuilder()\n .setWfRunId(WfRunId.newBuilder().setId("your-workflow-run-id"))\n .addEventDefIds(WorkflowEventDefId.newBuilder().setName("my-workflow-event-def"))\n // Ignore any WorkflowEvents matching the first one received\n // highlight-next-line\n .addWorkflowEventsToIgnore(event1.getId())\n .build());\n'})})}),(0,o.jsx)(i.A,{value:"python",label:"Python",default:!0,children:(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'async def main() -> None:\n config = get_config()\n client = config.stub()\n\n await_workflow_event_request = AwaitWorkflowEventRequest(\n wf_run_id=WfRunId(id="your-wf-run-id"),\n event_def_ids=[WorkflowEventDefId(name="my-workflow-event-def")],\n workflow_events_to_ignore=None)\n event1: WorkflowEvent = client.AwaitWorkflowEvent(await_workflow_event_request)\n\n await_workflow_event_request_2 = AwaitWorkflowEventRequest(\n wf_run_id=WfRunId(id="your-wf-run-id"),\n event_def_ids=[WorkflowEventDefId(name="my-workflow-event-def")],\n # Ignore any WorkflowEvents matching the first one received\n # highlight-next-line\n workflow_events_to_ignore=[event1.id])\n \n event2: WorkflowEvent = client.AwaitWorkflowEvent(await_workflow_event_request_2)\n'})})}),(0,o.jsx)(i.A,{value:"go",label:"Go",default:!0,children:(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\nevent1, err := (*client).AwaitWorkflowEvent(context.Background(),\n &lhproto.AwaitWorkflowEventRequest{\n WfRunId: &lhproto.WfRunId{\n Id: "your-workflow-run-id",\n },\n EventDefIds: []*lhproto.WorkflowEventDefId{\n &lhproto.WorkflowEventDefId{\n Name: "my-workflow-event-def",\n },\n },\n },\n)\n\nevent2, err := (*client).AwaitWorkflowEvent(context.Background(),\n &lhproto.AwaitWorkflowEventRequest{\n WfRunId: &lhproto.WfRunId{\n Id: "your-workflow-run-id",\n },\n EventDefIds: []*lhproto.WorkflowEventDefId{\n &lhproto.WorkflowEventDefId{\n Name: "my-workflow-event-def",\n },\n },\n // highlight-start\n WorkflowEventsToIgnore: []*lhproto.WorkflowEventId{\n event1.Id,\n },\n // highlight-end\n },\n)\n'})})})]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(f,{...e})}):f(e)}},9365:(e,n,t)=>{t.d(n,{A:()=>i});t(6540);var o=t(8215);const r={tabItem:"tabItem_Ymn6"};var l=t(4848);function i(e){let{children:n,hidden:t,className:i}=e;return(0,l.jsx)("div",{role:"tabpanel",className:(0,o.A)(r.tabItem,i),hidden:t,children:n})}},1470:(e,n,t)=>{t.d(n,{A:()=>E});var o=t(6540),r=t(8215),l=t(3104),i=t(6347),a=t(205),s=t(7485),d=t(1682),c=t(679);function u(e){return o.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,o.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad TaskDef",id:"taskdef",level:2},{value:"WfSpec",id:"wfspec",level:2},{value:"ExternalEventDef",id:"externaleventdef",level:2},{value:"UserTaskDef",id:"usertaskdef",level:2},{value:"WorkflowEventDef",id:"workfloweventdef",level:2}];function u(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"managing-metadata",children:"Managing Metadata"})}),"\n",(0,o.jsxs)(n.p,{children:["Before you can run a ",(0,o.jsx)(n.code,{children:"WfRun"}),", you need to create your ",(0,o.jsx)(n.code,{children:"WfSpec"}),"'s! This guide shows you how to do that."]}),"\n",(0,o.jsxs)(n.p,{children:["You can manage Metadata Objects (",(0,o.jsx)(n.code,{children:"WfSpec"}),", ",(0,o.jsx)(n.code,{children:"TaskDef"}),", ",(0,o.jsx)(n.code,{children:"ExternalEventDef"}),", and ",(0,o.jsx)(n.code,{children:"UserTaskDef"}),") either using ",(0,o.jsx)(n.code,{children:"lhctl"})," or with a grpc client. This section details how to manage them using the SDK's and grpc clients."]}),"\n",(0,o.jsxs)(n.p,{children:["Please note that, in LittleHorse, all metadata requests are idempotent. Additionally, if you make a metadata request to ",(0,o.jsx)(n.code,{children:"Put"})," an object with the exact same specifications of the object that already exists, the API will return the ",(0,o.jsx)(n.code,{children:"OK"})," grpc status. This is useful so that you can safely use CI/CD pipelines to manage metadata, or use a script that runs upon application startup to manage metadata, without having to catch ",(0,o.jsx)(n.code,{children:"ALREADY_EXISTS"})," errors."]}),"\n",(0,o.jsx)(n.h2,{id:"taskdef",children:(0,o.jsx)(n.code,{children:"TaskDef"})}),"\n",(0,o.jsxs)(n.p,{children:["In general, the easiest way to register a ",(0,o.jsx)(n.code,{children:"TaskDef"})," in LittleHorse is through a ",(0,o.jsx)(n.code,{children:"LHTaskWorker"})," object or struct."]}),"\n",(0,o.jsxs)(s.A,{children:[(0,o.jsxs)(l.A,{value:"java",label:"Java",default:!0,children:[(0,o.jsx)(n.p,{children:"Let's say I have a properly-annotated Task Worker class:"}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'class Greeter {\n @LHTaskMethod("greet")\n public String greeting(String name) {\n return "Hello there, " + name;\n }\n}\n'})}),(0,o.jsxs)(n.p,{children:["You can use the ",(0,o.jsx)(n.code,{children:"LHTaskWorker"})," to create the ",(0,o.jsx)(n.code,{children:"TaskDef"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'LHConfig config = ...;\nLHTaskWorker worker = new LHTaskWorker(new Greeter(), "greeting", config);\nworker.registerTaskDef();\n'})}),(0,o.jsxs)(n.p,{children:["You can get a ",(0,o.jsx)(n.code,{children:"TaskDef"})," or delete it using the grpc client:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'LittleHorseBlockingStub client = ...;\n\n// Get a TaskDef\nTaskDefId taskId = TaskDefId.newBuilder().setName("my-task").build();\nTaskDef myTask = client.getTaskDef(taskId);\n\n// Delete the task\nclient.deleteTaskDef(DeleteTaskDefRequest.newBuilder().setId(taskId).build());\n'})})]}),(0,o.jsxs)(l.A,{value:"go",label:"Go",children:[(0,o.jsxs)(n.p,{children:["You can use the ",(0,o.jsx)(n.code,{children:"LHTaskWorker"})," struct to automatically register a ",(0,o.jsx)(n.code,{children:"TaskDef"})," from your Task Function. First, create your ",(0,o.jsx)(n.code,{children:"LHTaskWorker"})," as follows (assuming that ",(0,o.jsx)(n.code,{children:"myTaskFunc"})," is a function pointer to your Task Function):"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\ntw, _ := taskworker.NewTaskWorker(config, myTaskFunc, "my-task")\n\n_, err := tw.RegisterTaskDef()\n'})}),(0,o.jsxs)(n.p,{children:["The above automatically generates a ",(0,o.jsx)(n.code,{children:"TaskDef"})," from the function signature using GoLang reflection, and registers it with the API."]}),(0,o.jsxs)(n.p,{children:["You can get and delete ",(0,o.jsx)(n.code,{children:"TaskDef"}),"'s as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'client, _ := config.GetGrpcClient()\ntaskDefId := &lhproto.TaskDefId{Name: "my-task"}\n\ntaskDef, err := (*client).GetTaskDef(context.Background(), taskDefId)\n\n// delete the TaskDef\n_, err = (*client).DeleteTaskDef(context.Background(), &lhproto.DeleteTaskDefRequest{\n Id: taskDefId,\n})\n'})})]}),(0,o.jsxs)(l.A,{value:"python",label:"Python",children:[(0,o.jsxs)(n.p,{children:["In the Python SDK, a function must be ",(0,o.jsx)(n.code,{children:"async"})," in order to be used as a Task Function. No annotations are required."]}),(0,o.jsxs)(n.p,{children:["The easiest way to register a ",(0,o.jsx)(n.code,{children:"TaskDef"})," to your LittleHorse Cluster is using the ",(0,o.jsx)(n.code,{children:"littlehorse.create_task_def()"})," utility function. The following example defines a Task Function and creates a ",(0,o.jsx)(n.code,{children:"TaskDef"})," in the LittleHorse Cluster."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'import asyncio\nfrom littlehorse import create_task_def\nfrom littlehorse.config import LHConfig\nfrom littlehorse.model.service_pb2 import *\nfrom google.protobuf.json_format import MessageToJson\n\n\n# This is the Task Function. It must be `async`.\nasync def greet(name: str) -> None:\n print(f"Hello there, {name}!")\n\n\nasync def main():\n config = LHConfig()\n\n # Let\'s use the string "greet-task" as the TaskDef\'s name\n create_task_def(greet, "greet-task", config)\n\n\nif __name__ == \'__main__\':\n asyncio.run(main())\n'})}),(0,o.jsxs)(n.p,{children:["You can delete a ",(0,o.jsx)(n.code,{children:"TaskDef"})," in python using the ",(0,o.jsx)(n.code,{children:"LittleHorseStub"})," and the ",(0,o.jsx)(n.a,{href:"/docs/api#deletetaskdef",children:(0,o.jsx)(n.code,{children:"rpc DeleteTaskDef"})}),". An example is shown below:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:"from littlehorse.config import LHConfig\nfrom littlehorse.model import *\n\n\nif __name__ == '__main__':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n # Formulate the request\n delete_td_request = DeleteTaskDefRequest(id=TaskDefId(name=\"greet-task\"))\n\n # Delete the TaskDef\n client.DeleteTaskDef(delete_td_request)\n"})})]})]}),"\n",(0,o.jsx)(n.h2,{id:"wfspec",children:(0,o.jsx)(n.code,{children:"WfSpec"})}),"\n",(0,o.jsxs)(n.p,{children:["In LittleHorse, the easiest way to deploy a ",(0,o.jsx)(n.code,{children:"WfSpec"})," is using the ",(0,o.jsx)(n.code,{children:"Workflow"})," class or struct provided by our Java, Go, and Python SDK's. The ",(0,o.jsx)(n.code,{children:"Workflow"})," class takes in a ",(0,o.jsx)(n.code,{children:"WorkflowThread"})," function reference that defines your ",(0,o.jsx)(n.code,{children:"WfSpec"})," logic (this is covered in the ",(0,o.jsx)(n.a,{href:"/docs/developer-guide/wfspec-development/",children:"Developing Workflows Documentation"}),"), and has a ",(0,o.jsx)(n.code,{children:"compile()"})," method which returns a ",(0,o.jsx)(n.code,{children:"PutWfSpecRequest"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Like other metadata requests, the ",(0,o.jsx)(n.code,{children:"rpc PutWfSpec"})," is idempotent. However, as described in our ",(0,o.jsxs)(n.a,{href:"/docs/concepts/advanced/wfspec-versioning",children:[(0,o.jsx)(n.code,{children:"WfSpec"})," Versioning docs"]}),", ",(0,o.jsx)(n.code,{children:"WfSpec"})," objects have compound versioning that enforces certain compatibility rules between versions. In the ",(0,o.jsx)(n.code,{children:"PutWfSpecRequest"}),", you have the option to set the ",(0,o.jsx)(n.code,{children:"allowed_updates"})," field of the ",(0,o.jsx)(n.code,{children:"PutWfSpecRequest"}),". There are three values:"]}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"ALL_UPDATES"}),": both breaking changes and minor revisions are accepted."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"MINOR_REVISION_UPDATES"}),": breaking changes are rejected, but minor revisions are accepted."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"NO_UPDATES"}),": the request will fail if the specified new ",(0,o.jsx)(n.code,{children:"WfSpec"})," differs from the latest version."]}),"\n"]}),"\n",(0,o.jsxs)(s.A,{children:[(0,o.jsxs)(l.A,{value:"java",label:"Java",default:!0,children:[(0,o.jsxs)(n.p,{children:["You can execute the ",(0,o.jsx)(n.code,{children:"PutWfSpecRequest"})," with a specific ",(0,o.jsx)(n.code,{children:"AllowedUpdateType"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.wfsdk.Workflow;\nimport io.littlehorse.sdk.wfsdk.WorkflowThread;\nimport io.littlehorse.sdk.common.proto.AllowedUpdateType;\nimport io.littlehorse.sdk.common.proto.PutWfSpecRequest;\nimport io.littlehorse.sdk.common.proto.WfSpec;\n\npublic class Main {\n\n private static void wfFunc(WorkflowThread wf) {\n // The `greet` TaskDef must already exist\n wf.execute("greet", "some-name");\n }\n\n public static void main(String[] args) throws IOException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n Workflow workflow = Workflow.newWorkflow("my-wfspec", Main::wfFunc);\n\n // Only allow updates that do not change the API of the WfSpec\n workflow.withUpdateType(AllowedUpdateType.MINOR_REVISION_UPDATES);\n\n PutWfSpecRequest request = workflow.compileWorkflow();\n WfSpec result = client.putWfSpec(request);\n\n System.out.println(LHLibUtil.protoToJson(result));\n }\n}\n'})}),(0,o.jsxs)(n.p,{children:["You can get or delete a ",(0,o.jsx)(n.code,{children:"WfSpec"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.common.proto.DeleteWfSpecRequest;\nimport io.littlehorse.sdk.common.proto.WfSpec;\nimport io.littlehorse.sdk.common.proto.WfSpecId;\n\npublic class Main {\n\n public static void main(String[] args) throws IOException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n WfSpecId wfSpecId = WfSpecId.newBuilder()\n .setName("my-wfspec")\n .setMajorVersion(0) // Set to whichever major version you want\n .setRevision(0) // Set to whichever revision you want\n .build();\n\n WfSpec wfSpec = client.getWfSpec(wfSpecId);\n System.out.println(LHLibUtil.protoToJson(wfSpec));\n\n // Delete the WfSpec\n DeleteWfSpecRequest req = DeleteWfSpecRequest.newBuilder().setId(wfSpecId).build();\n client.deleteWfSpec(req);\n }\n}\n'})})]}),(0,o.jsxs)(l.A,{value:"go",label:"Go",children:[(0,o.jsxs)(n.p,{children:["Assuming that you have a function ",(0,o.jsx)(n.code,{children:"basic.MyWorkflow"})," which is a valid Workflow Function in Go, you can create a ",(0,o.jsx)(n.code,{children:"WfSpec"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\nwf := littlehorse.NewWorkflow(basic.MyWorkflow, "my-workflow").WithUpdateType(lhproto.AllowedUpdateType_MINOR_REVISION_UPDATES)\nputWf, _ := wf.Compile()\n\nresp, err := (*client).PutWfSpec(context.Background(), putWf)\n'})}),(0,o.jsxs)(n.p,{children:["You can get and delete ",(0,o.jsx)(n.code,{children:"WfSpec"}),"s as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'wfSpecId := &lhproto.WfSpecId{\n Name: "my-wf",\n MajorVersion: 2,\n Revision: 1,\n}\n\nwfSpec, err := (*client).GetWfSpec(context.Background(), wfSpecId)\n\n// Get the latest wfSpec. Setting majorVersion is optional for this request\nmajorVersion := int32(2)\n\nsomeWf, err := (*client).GetLatestWfSpec(\n context.Background(),\n &lhproto.GetLatestWfSpecRequest{\n Name: "some-wf",\n MajorVersion: &majorVersion,\n },\n)\n\n// delete the WfSpec\n_, err = (*client).DeleteWfSpec(context.Background(), &lhproto.DeleteWfSpecRequest{\n Id: wfSpecId,\n})\n'})})]}),(0,o.jsxs)(l.A,{value:"python",label:"Python",children:[(0,o.jsxs)(n.p,{children:["Assuming you have a workflow, you can use the ",(0,o.jsx)(n.code,{children:"littlehorse.create_workflow_spec()"})," utility function."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'from littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom littlehorse.workflow import Workflow, WorkflowThread\nfrom google.protobuf.json_format import MessageToJson\n\n# The workflow logic. This function must have type annotations in\n# order to conform to the `ThreadInitializer` interface.\ndef my_workflow_func(wf: WorkflowThread) -> None:\n # the `greet` TaskDef must already exist\n wf.execute("greet", "some-name")\n\n\nif __name__ == \'__main__\':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n workflow: Workflow = Workflow("my-wfspec", my_workflow_func)\n # Set the allowed update type\n workflow.with_update_type(AllowedUpdateType.MINOR_REVISION_UPDATES)\n\n # Create the WfSpec\n request: PutWfSpecRequest = workflow.compile()\n wf_spec: WfSpec = client.PutWfSpec(request)\n\n print(MessageToJson(wf_spec))\n'})}),(0,o.jsxs)(n.p,{children:["You can get or delete a WfSpec using a ",(0,o.jsx)(n.code,{children:"stub"}),":"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'from littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom littlehorse.workflow import Workflow, WorkflowThread\nfrom google.protobuf.json_format import MessageToJson\n\n# The workflow logic. This function must have type annotations in\n# order to conform to the `ThreadInitializer` interface.\ndef my_workflow_func(wf: WorkflowThread) -> None:\n # the `greet` TaskDef must already exist\n wf.execute("greet", "some-name")\n\n\nif __name__ == \'__main__\':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n wf_spec_id: WfSpecId = WfSpecId(\n name="my-wfspec",\n major_version=0, # replace with your preferred major version\n revision=0, # replaced with your desired revision\n )\n wf_spec: WfSpec = client.GetWfSpec(wf_spec_id)\n\n print(MessageToJson(wf_spec))\n\n # Delete a WfSpec\n client.DeleteWfSpec(DeleteWfSpecRequest(id=wf_spec_id))\n'})})]})]}),"\n",(0,o.jsx)(n.h2,{id:"externaleventdef",children:(0,o.jsx)(n.code,{children:"ExternalEventDef"})}),"\n",(0,o.jsxs)(n.p,{children:["As of now, the only field required to create an ",(0,o.jsx)(n.code,{children:"ExternalEventDef"})," is the ",(0,o.jsx)(n.code,{children:"name"})," of the ",(0,o.jsx)(n.code,{children:"ExternalEventDef"}),"."]}),"\n",(0,o.jsxs)(s.A,{children:[(0,o.jsxs)(l.A,{value:"java",label:"Java",default:!0,children:[(0,o.jsxs)(n.p,{children:["You can create, get, and delete an ",(0,o.jsx)(n.code,{children:"ExternalEventDef"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.common.proto.DeleteExternalEventDefRequest;\nimport io.littlehorse.sdk.common.proto.ExternalEventDef;\nimport io.littlehorse.sdk.common.proto.ExternalEventDefId;\nimport io.littlehorse.sdk.common.proto.PutExternalEventDefRequest;\n\npublic class Main {\n\n public static void main(String[] args) throws IOException, InterruptedException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n PutExternalEventDefRequest request = PutExternalEventDefRequest.newBuilder()\n .setName("my-external-event-def")\n .build();\n\n client.putExternalEventDef(request);\n\n // Metadata requests in LittleHorse take 50-100 ms to propagate to the global\n // store.\n Thread.sleep(100);\n\n // Retrieve the ExternalEventDef\n ExternalEventDefId id = ExternalEventDefId.newBuilder()\n .setName("my-external-event-def")\n .build();\n ExternalEventDef eventDef = client.getExternalEventDef(id);\n System.out.println(LHLibUtil.protoToJson(eventDef));\n\n // Delete the ExternalEventDef\n DeleteExternalEventDefRequest deleteRequest = DeleteExternalEventDefRequest.newBuilder()\n .setId(id)\n .build();\n client.deleteExternalEventDef(deleteRequest);\n }\n}\n'})})]}),(0,o.jsxs)(l.A,{value:"go",label:"Go",children:[(0,o.jsxs)(n.p,{children:["In Go, you can create a ",(0,o.jsx)(n.code,{children:"ExternalEventDef"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\nresp, err := (*client).PutExternalEventDef(context.Background(),\n &lhproto.PutExternalEventDefRequest{\n Name: "my-external-event-def",\n },\n)\n'})}),(0,o.jsxs)(n.p,{children:["You can get and delete ",(0,o.jsx)(n.code,{children:"ExternalEventDef"}),"s as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'externalEventDefId := &lhproto.ExternalEventDefId{\n Name: "some-event",\n}\need, err := (*client).GetExternalEventDef(context.Background(), externalEventDefId)\n\n// delete the ExternalEventDef\n_, err = (*client).DeleteExternalEventDef(context.Background(), &lhproto.DeleteExternalEventDefRequest{\n Id: externalEventDefId,\n})\n'})})]}),(0,o.jsxs)(l.A,{value:"python",label:"Python",children:[(0,o.jsxs)(n.p,{children:["In Python, you can use the ",(0,o.jsx)(n.code,{children:"littlehorse.create_external_event_def"})," utility to more easily create an ",(0,o.jsx)(n.code,{children:"ExternalEventDef"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'from littlehorse import create_external_event_def\nfrom littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom google.protobuf.json_format import MessageToJson\n\nfrom time import sleep\n\n\nif __name__ == \'__main__\':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n create_external_event_def(name="my-external-event-def", config=config)\n\n # In LittleHorse, metadata updates take 50-100ms to propagate to the global\n # store.\n sleep(0.2)\n\n # Fetch the ExternalEventDef\n external_event_def_id = ExternalEventDefId(name="my-external-event-def")\n event_def: ExternalEventDef = client.GetExternalEventDef(external_event_def_id)\n print(MessageToJson(event_def))\n\n # Delete the ExternalEventDef\n client.DeleteExternalEventDef(DeleteExternalEventDefRequest(id=external_event_def_id))\n'})})]})]}),"\n",(0,o.jsx)(n.h2,{id:"usertaskdef",children:(0,o.jsx)(n.code,{children:"UserTaskDef"})}),"\n",(0,o.jsxs)(n.p,{children:["A ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," specifies the data that needs to be filled out in a form for a human to complete a ",(0,o.jsx)(n.code,{children:"UserTaskRun"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Note that a ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," is a versioned object (unlike a ",(0,o.jsx)(n.code,{children:"WfSpec"}),", however, there is only a ",(0,o.jsx)(n.code,{children:"version"})," number and no ",(0,o.jsx)(n.code,{children:"revision"}),"). As such, getting and deleting ",(0,o.jsx)(n.code,{children:"UserTaskDef"}),"s follows a similar pattern: we provide a ",(0,o.jsx)(n.code,{children:"GetLatestUserTaskDef"})," rpc call which allows you to get the latest ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," with a given name."]}),"\n",(0,o.jsxs)(s.A,{children:[(0,o.jsxs)(l.A,{value:"java",label:"Java",default:!0,children:[(0,o.jsxs)(n.p,{children:["The easiest way to create a ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," in Java is using the ",(0,o.jsx)(n.code,{children:"UserTaskSchema"})," class. Note that it infers the schema of the ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," from our ",(0,o.jsx)(n.code,{children:"MyForm"})," class using the ",(0,o.jsx)(n.code,{children:"UserTaskField"})," annotation."]}),(0,o.jsxs)(n.p,{children:["The below example shows you how to create a ",(0,o.jsx)(n.code,{children:"UserTaskDef"}),", get it, and delete it."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.usertask.UserTaskSchema;\nimport io.littlehorse.sdk.usertask.annotations.UserTaskField;\nimport io.littlehorse.sdk.common.proto.DeleteUserTaskDefRequest;\nimport io.littlehorse.sdk.common.proto.PutUserTaskDefRequest;\nimport io.littlehorse.sdk.common.proto.UserTaskDef;\nimport io.littlehorse.sdk.common.proto.UserTaskDefId;\n\n// This Java class defines our form for the UserTaskDef\nclass SomeForm {\n @UserTaskField(\n displayName = "Approved?",\n description = "Reply \'true\' if this is an acceptable request."\n )\n public boolean isApproved;\n\n @UserTaskField(\n displayName = "Explanation",\n description = "Explain your answer",\n required = false\n )\n public String explanation;\n}\n\n\npublic class Main {\n public static void main(String[] args) throws IOException, InterruptedException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n String userTaskDefName = "my-user-task-def";\n\n // Compile the above Java class into a UserTaskDef\n UserTaskSchema userTask = new UserTaskSchema(new SomeForm(), userTaskDefName);\n PutUserTaskDefRequest putRequest = userTask.compile();\n\n // Register the UserTaskDef into LittleHorse\n client.putUserTaskDef(putRequest);\n\n // Get the UserTaskDef. Note that metadata creation takes 50-100ms to propagate\n // through the LittleHorse cluster.\n Thread.sleep(200);\n\n UserTaskDefId id = UserTaskDefId.newBuilder()\n .setName(userTaskDefName)\n .setVersion(0)\n .build();\n UserTaskDef result = client.getUserTaskDef(id);\n System.out.println(LHLibUtil.protoToJson(result));\n\n // Delete the UserTaskDef\n DeleteUserTaskDefRequest deleteRequest = DeleteUserTaskDefRequest.newBuilder()\n .setId(id)\n .build();\n\n client.deleteUserTaskDef(deleteRequest);\n }\n}\n'})})]}),(0,o.jsxs)(l.A,{value:"go",label:"Go",children:[(0,o.jsxs)(n.p,{children:["To create a ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," in Go, you can create the ",(0,o.jsx)(n.code,{children:"PutUserTaskDefRequest"})," object."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\ndescription := "this is a cool usertaskdef!"\nresult, err := (*client).PutUserTaskDef(context.Background(),\n &lhproto.PutUserTaskDefRequest{\n Name: "my-user-task",\n\t\tFields: []*lhproto.UserTaskField{\n\t\t\t&lhproto.UserTaskField{\n\t\t\t\tName: "my-first-int-field",\n\t\t\t\tType: lhproto.VariableType_INT,\n\t\t\t},\n\t\t\t&lhproto.UserTaskField{\n\t\t\t\tName: "my-second-str-field",\n\t\t\t\tType: lhproto.VariableType_STR,\n\t\t\t},\n\t\t},\n\t\tDescription: &description,\n },\n)\n'})})]}),(0,o.jsxs)(l.A,{value:"python",label:"Python",children:[(0,o.jsxs)(n.p,{children:["In python, you can create a ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," using ",(0,o.jsx)(n.a,{href:"/docs/api#putusertaskdef",children:(0,o.jsx)(n.code,{children:"rpc PutUserTaskDef"})}),"."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'from littlehorse import create_external_event_def\nfrom littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom google.protobuf.json_format import MessageToJson\n\nfrom time import sleep\n\n\nif __name__ == \'__main__\':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n # Manually construct the PutUserTaskDefRequest, specifying the fields we want\n # the UserTaskRun\'s to have.\n put_user_task_def_req = PutUserTaskDefRequest(\n name="my-user-task-def",\n fields=[\n UserTaskField(\n name="isApproved",\n description="Is the request Approved?",\n display_name="Approved?",\n required=True,\n ),\n UserTaskField(\n name="explanation",\n description="Explanation or comments for decision.",\n required=False,\n display_name="Comments",\n )\n ]\n )\n\n # Create the UserTaskDef\n client.PutUserTaskDef(put_user_task_def_req)\n\n # Wait for metadata to propagate\n sleep(0.5)\n\n # Get the UserTaskDef\n user_task_def_id = UserTaskDefId(name="my-user-task-def", version=0)\n user_task_def = client.GetUserTaskDef(user_task_def_id)\n print(MessageToJson(user_task_def))\n\n # Delete the UserTaskDef\n client.DeleteUserTaskDef(DeleteUserTaskDefRequest(id=user_task_def_id))\n'})})]})]}),"\n",(0,o.jsx)(n.h2,{id:"workfloweventdef",children:(0,o.jsx)(n.code,{children:"WorkflowEventDef"})}),"\n",(0,o.jsxs)(s.A,{children:[(0,o.jsxs)(l.A,{value:"java",label:"Java",default:!0,children:[(0,o.jsxs)(n.p,{children:["You can create, get, and delete a ",(0,o.jsx)(n.code,{children:"WorkflowEventDef"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.common.proto.DeleteWorkflowEventDefRequest;\nimport io.littlehorse.sdk.common.proto.PutWorkflowEventDefRequest;\nimport io.littlehorse.sdk.common.proto.VariableType;\nimport io.littlehorse.sdk.common.proto.WorkflowEventDef;\nimport io.littlehorse.sdk.common.proto.WorkflowEventDefId;\n\npublic class Main {\n\n public static void main(String[] args) throws IOException, InterruptedException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n PutWorkflowEventDefRequest request = PutWorkflowEventDefRequest.newBuilder()\n .setName("my-workflow-event-def")\n .setType(VariableType.STR)\n .build();\n \n\n client.putWorkflowEventDef(request);\n\n // Metadata requests in LittleHorse take 50-100 ms to propagate to the global\n // store.\n Thread.sleep(100);\n\n // Retrieve the WorkflowEventDef\n WorkflowEventDefId id = WorkflowEventDefId.newBuilder()\n .setName("my-workflow-event-def")\n .build();\n WorkflowEventDef eventDef = client.getWorkflowEventDef(id);\n System.out.println(LHLibUtil.protoToJson(eventDef));\n\n // Delete the WorkflowEventDef\n DeleteWorkflowEventDefRequest deleteRequest = DeleteWorkflowEventDefRequest.newBuilder()\n .setId(id)\n .build();\n client.deleteWorkflowEventDef(deleteRequest);\n }\n}\n'})})]}),(0,o.jsxs)(l.A,{value:"go",label:"Go",children:[(0,o.jsxs)(n.p,{children:["In Go, you can create a ",(0,o.jsx)(n.code,{children:"WorkflowEventDef"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\nresp, err := (*client).PutWorkflowEventDef(context.Background(),\n &lhproto.PutWorkflowEventDef{\n Name: "my-workflow-event-def",\n },\n)\n'})}),(0,o.jsxs)(n.p,{children:["You can get and delete ",(0,o.jsx)(n.code,{children:"WorkflowEventDef"}),"s as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'workflowEventDefId := &lhproto.WorkflowEventDefId{\n Name: "my-workflow-event-def",\n}\need, err := (*client).GetWorkflowEventDef(context.Background(), workflowEventDefId)\n\n// delete the WorkflowEventDef\n_, err = (*client).DeleteWorkflowEventDef(context.Background(), &lhproto.DeleteWorkflowEventDefRequest{\n Id: workflowEventId,\n})\n'})})]}),(0,o.jsxs)(l.A,{value:"python",label:"Python",children:[(0,o.jsxs)(n.p,{children:["In Python, you can use the ",(0,o.jsx)(n.code,{children:"littlehorse.create_workflow_event_def"})," utility to more easily create a ",(0,o.jsx)(n.code,{children:"WorkflowEventDef"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'from littlehorse import create_workflow_event_def\nfrom littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom google.protobuf.json_format import MessageToJson\n\nfrom time import sleep\n\n\nif __name__ == \'__main__\':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n create_workflow_event_def(name="my-workflow-event-def", config=config)\n\n # In LittleHorse, metadata updates take 50-100ms to propagate to the global\n # store.\n sleep(0.2)\n\n # Fetch the WorkflowEventDef\n workflow_event_def_id = WorkflowEventDefId(name="my-workflow-event-def")\n event_def: WorkflowEventDef = client.GetWorkflowEventDef(workflow_event_def_id)\n print(MessageToJson(event_def))\n\n # Delete the WorkflowEventDef\n client.DeleteWorkflowEventDef(DeleteWorkflowEventDefRequest(id=workflow_event_def_id))\n'})})]})]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},9365:(e,n,t)=>{t.d(n,{A:()=>l});t(6540);var o=t(8215);const r={tabItem:"tabItem_Ymn6"};var s=t(4848);function l(e){let{children:n,hidden:t,className:l}=e;return(0,s.jsx)("div",{role:"tabpanel",className:(0,o.A)(r.tabItem,l),hidden:t,children:n})}},1470:(e,n,t)=>{t.d(n,{A:()=>D});var o=t(6540),r=t(8215),s=t(3104),l=t(6347),i=t(205),a=t(7485),c=t(1682),d=t(679);function f(e){return o.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,o.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad TaskDef",id:"taskdef",level:2},{value:"WfSpec",id:"wfspec",level:2},{value:"ExternalEventDef",id:"externaleventdef",level:2},{value:"UserTaskDef",id:"usertaskdef",level:2}];function f(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"managing-metadata",children:"Managing Metadata"})}),"\n",(0,o.jsxs)(n.p,{children:["Before you can run a ",(0,o.jsx)(n.code,{children:"WfRun"}),", you need to create your ",(0,o.jsx)(n.code,{children:"WfSpec"}),"'s! This guide shows you how to do that."]}),"\n",(0,o.jsxs)(n.p,{children:["You can manage Metadata Objects (",(0,o.jsx)(n.code,{children:"WfSpec"}),", ",(0,o.jsx)(n.code,{children:"TaskDef"}),", ",(0,o.jsx)(n.code,{children:"ExternalEventDef"}),", and ",(0,o.jsx)(n.code,{children:"UserTaskDef"}),") either using ",(0,o.jsx)(n.code,{children:"lhctl"})," or with a grpc client. This section details how to manage them using the SDK's and grpc clients."]}),"\n",(0,o.jsxs)(n.p,{children:["Please note that, in LittleHorse, all metadata requests are idempotent. Additionally, if you make a metadata request to ",(0,o.jsx)(n.code,{children:"Put"})," an object with the exact same specifications of the object that already exists, the API will return the ",(0,o.jsx)(n.code,{children:"OK"})," grpc status. This is useful so that you can safely use CI/CD pipelines to manage metadata, or use a script that runs upon application startup to manage metadata, without having to catch ",(0,o.jsx)(n.code,{children:"ALREADY_EXISTS"})," errors."]}),"\n",(0,o.jsx)(n.h2,{id:"taskdef",children:(0,o.jsx)(n.code,{children:"TaskDef"})}),"\n",(0,o.jsxs)(n.p,{children:["In general, the easiest way to register a ",(0,o.jsx)(n.code,{children:"TaskDef"})," in LittleHorse is through a ",(0,o.jsx)(n.code,{children:"LHTaskWorker"})," object or struct."]}),"\n",(0,o.jsxs)(s.A,{children:[(0,o.jsxs)(a.A,{value:"java",label:"Java",default:!0,children:[(0,o.jsx)(n.p,{children:"Let's say I have a properly-annotated Task Worker class:"}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'class Greeter {\n @LHTaskMethod("greet")\n public String greeting(String name) {\n return "Hello there, " + name;\n }\n}\n'})}),(0,o.jsxs)(n.p,{children:["You can use the ",(0,o.jsx)(n.code,{children:"LHTaskWorker"})," to create the ",(0,o.jsx)(n.code,{children:"TaskDef"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'LHConfig config = ...;\nLHTaskWorker worker = new LHTaskWorker(new Greeter(), "greeting", config);\nworker.registerTaskDef();\n'})}),(0,o.jsxs)(n.p,{children:["You can get a ",(0,o.jsx)(n.code,{children:"TaskDef"})," or delete it using the grpc client:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'LittleHorseBlockingStub client = ...;\n\n// Get a TaskDef\nTaskDefId taskId = TaskDefId.newBuilder().setName("my-task").build();\nTaskDef myTask = client.getTaskDef(taskId);\n\n// Delete the task\nclient.deleteTaskDef(DeleteTaskDefRequest.newBuilder().setId(taskId).build());\n'})})]}),(0,o.jsxs)(a.A,{value:"go",label:"Go",children:[(0,o.jsxs)(n.p,{children:["You can use the ",(0,o.jsx)(n.code,{children:"LHTaskWorker"})," struct to automatically register a ",(0,o.jsx)(n.code,{children:"TaskDef"})," from your Task Function. First, create your ",(0,o.jsx)(n.code,{children:"LHTaskWorker"})," as follows (assuming that ",(0,o.jsx)(n.code,{children:"myTaskFunc"})," is a function pointer to your Task Function):"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\ntw, _ := taskworker.NewTaskWorker(config, myTaskFunc, "my-task")\n\n_, err := tw.RegisterTaskDef()\n'})}),(0,o.jsxs)(n.p,{children:["The above automatically generates a ",(0,o.jsx)(n.code,{children:"TaskDef"})," from the function signature using GoLang reflection, and registers it with the API."]}),(0,o.jsxs)(n.p,{children:["You can get and delete ",(0,o.jsx)(n.code,{children:"TaskDef"}),"'s as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'client, _ := config.GetGrpcClient()\ntaskDefId := &lhproto.TaskDefId{Name: "my-task"}\n\ntaskDef, err := (*client).GetTaskDef(context.Background(), taskDefId)\n\n// delete the TaskDef\n_, err = (*client).DeleteTaskDef(context.Background(), &lhproto.DeleteTaskDefRequest{\n Id: taskDefId,\n})\n'})})]}),(0,o.jsxs)(a.A,{value:"python",label:"Python",children:[(0,o.jsxs)(n.p,{children:["In the Python SDK, a function must be ",(0,o.jsx)(n.code,{children:"async"})," in order to be used as a Task Function. No annotations are required."]}),(0,o.jsxs)(n.p,{children:["The easiest way to register a ",(0,o.jsx)(n.code,{children:"TaskDef"})," to your LittleHorse Cluster is using the ",(0,o.jsx)(n.code,{children:"littlehorse.create_task_def()"})," utility function. The following example defines a Task Function and creates a ",(0,o.jsx)(n.code,{children:"TaskDef"})," in the LittleHorse Cluster."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'import asyncio\nfrom littlehorse import create_task_def\nfrom littlehorse.config import LHConfig\nfrom littlehorse.model.service_pb2 import *\nfrom google.protobuf.json_format import MessageToJson\n\n\n# This is the Task Function. It must be `async`.\nasync def greet(name: str) -> None:\n print(f"Hello there, {name}!")\n\n\nasync def main():\n config = LHConfig()\n\n # Let\'s use the string "greet-task" as the TaskDef\'s name\n create_task_def(greet, "greet-task", config)\n\n\nif __name__ == \'__main__\':\n asyncio.run(main())\n'})}),(0,o.jsxs)(n.p,{children:["You can delete a ",(0,o.jsx)(n.code,{children:"TaskDef"})," in python using the ",(0,o.jsx)(n.code,{children:"LittleHorseStub"})," and the ",(0,o.jsx)(n.a,{href:"/docs/api#deletetaskdef",children:(0,o.jsx)(n.code,{children:"rpc DeleteTaskDef"})}),". An example is shown below:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:"from littlehorse.config import LHConfig\nfrom littlehorse.model import *\n\n\nif __name__ == '__main__':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n # Formulate the request\n delete_td_request = DeleteTaskDefRequest(id=TaskDefId(name=\"greet-task\"))\n\n # Delete the TaskDef\n client.DeleteTaskDef(delete_td_request)\n"})})]})]}),"\n",(0,o.jsx)(n.h2,{id:"wfspec",children:(0,o.jsx)(n.code,{children:"WfSpec"})}),"\n",(0,o.jsxs)(n.p,{children:["In LittleHorse, the easiest way to deploy a ",(0,o.jsx)(n.code,{children:"WfSpec"})," is using the ",(0,o.jsx)(n.code,{children:"Workflow"})," class or struct provided by our Java, Go, and Python SDK's. The ",(0,o.jsx)(n.code,{children:"Workflow"})," class takes in a ",(0,o.jsx)(n.code,{children:"WorkflowThread"})," function reference that defines your ",(0,o.jsx)(n.code,{children:"WfSpec"})," logic (this is covered in the ",(0,o.jsx)(n.a,{href:"/docs/developer-guide/wfspec-development/",children:"Developing Workflows Documentation"}),"), and has a ",(0,o.jsx)(n.code,{children:"compile()"})," method which returns a ",(0,o.jsx)(n.code,{children:"PutWfSpecRequest"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Like other metadata requests, the ",(0,o.jsx)(n.code,{children:"rpc PutWfSpec"})," is idempotent. However, as described in our ",(0,o.jsxs)(n.a,{href:"/docs/concepts/advanced/wfspec-versioning",children:[(0,o.jsx)(n.code,{children:"WfSpec"})," Versioning docs"]}),", ",(0,o.jsx)(n.code,{children:"WfSpec"})," objects have compound versioning that enforces certain compatibility rules between versions. In the ",(0,o.jsx)(n.code,{children:"PutWfSpecRequest"}),", you have the option to set the ",(0,o.jsx)(n.code,{children:"allowed_updates"})," field of the ",(0,o.jsx)(n.code,{children:"PutWfSpecRequest"}),". There are three values:"]}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"ALL_UPDATES"}),": both breaking changes and minor revisions are accepted."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"MINOR_REVISION_UPDATES"}),": breaking changes are rejected, but minor revisions are accepted."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"NO_UPDATES"}),": the request will fail if the specified new ",(0,o.jsx)(n.code,{children:"WfSpec"})," differs from the latest version."]}),"\n"]}),"\n",(0,o.jsxs)(s.A,{children:[(0,o.jsxs)(a.A,{value:"java",label:"Java",default:!0,children:[(0,o.jsxs)(n.p,{children:["You can execute the ",(0,o.jsx)(n.code,{children:"PutWfSpecRequest"})," with a specific ",(0,o.jsx)(n.code,{children:"AllowedUpdateType"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.wfsdk.Workflow;\nimport io.littlehorse.sdk.wfsdk.WorkflowThread;\nimport io.littlehorse.sdk.common.proto.AllowedUpdateType;\nimport io.littlehorse.sdk.common.proto.PutWfSpecRequest;\nimport io.littlehorse.sdk.common.proto.WfSpec;\n\npublic class Main {\n\n private static void wfFunc(WorkflowThread wf) {\n // The `greet` TaskDef must already exist\n wf.execute("greet", "some-name");\n }\n\n public static void main(String[] args) throws IOException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n Workflow workflow = Workflow.newWorkflow("my-wfspec", Main::wfFunc);\n\n // Only allow updates that do not change the API of the WfSpec\n workflow.withUpdateType(AllowedUpdateType.MINOR_REVISION_UPDATES);\n\n PutWfSpecRequest request = workflow.compileWorkflow();\n WfSpec result = client.putWfSpec(request);\n\n System.out.println(LHLibUtil.protoToJson(result));\n }\n}\n'})}),(0,o.jsxs)(n.p,{children:["You can get or delete a ",(0,o.jsx)(n.code,{children:"WfSpec"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.common.proto.DeleteWfSpecRequest;\nimport io.littlehorse.sdk.common.proto.WfSpec;\nimport io.littlehorse.sdk.common.proto.WfSpecId;\n\npublic class Main {\n\n public static void main(String[] args) throws IOException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n WfSpecId wfSpecId = WfSpecId.newBuilder()\n .setName("my-wfspec")\n .setMajorVersion(0) // Set to whichever major version you want\n .setRevision(0) // Set to whichever revision you want\n .build();\n\n WfSpec wfSpec = client.getWfSpec(wfSpecId);\n System.out.println(LHLibUtil.protoToJson(wfSpec));\n\n // Delete the WfSpec\n DeleteWfSpecRequest req = DeleteWfSpecRequest.newBuilder().setId(wfSpecId).build();\n client.deleteWfSpec(req);\n }\n}\n'})})]}),(0,o.jsxs)(a.A,{value:"go",label:"Go",children:[(0,o.jsxs)(n.p,{children:["Assuming that you have a function ",(0,o.jsx)(n.code,{children:"basic.MyWorkflow"})," which is a valid Workflow Function in Go, you can create a ",(0,o.jsx)(n.code,{children:"WfSpec"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\nwf := littlehorse.NewWorkflow(basic.MyWorkflow, "my-workflow").WithUpdateType(lhproto.AllowedUpdateType_MINOR_REVISION_UPDATES)\nputWf, _ := wf.Compile()\n\nresp, err := (*client).PutWfSpec(context.Background(), putWf)\n'})}),(0,o.jsxs)(n.p,{children:["You can get and delete ",(0,o.jsx)(n.code,{children:"WfSpec"}),"s as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'wfSpecId := &lhproto.WfSpecId{\n Name: "my-wf",\n MajorVersion: 2,\n Revision: 1,\n}\n\nwfSpec, err := (*client).GetWfSpec(context.Background(), wfSpecId)\n\n// Get the latest wfSpec. Setting majorVersion is optional for this request\nmajorVersion := int32(2)\n\nsomeWf, err := (*client).GetLatestWfSpec(\n context.Background(),\n &lhproto.GetLatestWfSpecRequest{\n Name: "some-wf",\n MajorVersion: &majorVersion,\n },\n)\n\n// delete the WfSpec\n_, err = (*client).DeleteWfSpec(context.Background(), &lhproto.DeleteWfSpecRequest{\n Id: wfSpecId,\n})\n'})})]}),(0,o.jsxs)(a.A,{value:"python",label:"Python",children:[(0,o.jsxs)(n.p,{children:["Assuming you have a workflow, you can use the ",(0,o.jsx)(n.code,{children:"littlehorse.create_workflow_spec()"})," utility function."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'from littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom littlehorse.workflow import Workflow, WorkflowThread\nfrom google.protobuf.json_format import MessageToJson\n\n# The workflow logic. This function must have type annotations in\n# order to conform to the `ThreadInitializer` interface.\ndef my_workflow_func(wf: WorkflowThread) -> None:\n # the `greet` TaskDef must already exist\n wf.execute("greet", "some-name")\n\n\nif __name__ == \'__main__\':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n workflow: Workflow = Workflow("my-wfspec", my_workflow_func)\n # Set the allowed update type\n workflow.with_update_type(AllowedUpdateType.MINOR_REVISION_UPDATES)\n\n # Create the WfSpec\n request: PutWfSpecRequest = workflow.compile()\n wf_spec: WfSpec = client.PutWfSpec(request)\n\n print(MessageToJson(wf_spec))\n'})}),(0,o.jsxs)(n.p,{children:["You can get or delete a WfSpec using a ",(0,o.jsx)(n.code,{children:"stub"}),":"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'from littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom littlehorse.workflow import Workflow, WorkflowThread\nfrom google.protobuf.json_format import MessageToJson\n\n# The workflow logic. This function must have type annotations in\n# order to conform to the `ThreadInitializer` interface.\ndef my_workflow_func(wf: WorkflowThread) -> None:\n # the `greet` TaskDef must already exist\n wf.execute("greet", "some-name")\n\n\nif __name__ == \'__main__\':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n wf_spec_id: WfSpecId = WfSpecId(\n name="my-wfspec",\n major_version=0, # replace with your preferred major version\n revision=0, # replaced with your desired revision\n )\n wf_spec: WfSpec = client.GetWfSpec(wf_spec_id)\n\n print(MessageToJson(wf_spec))\n\n # Delete a WfSpec\n client.DeleteWfSpec(DeleteWfSpecRequest(id=wf_spec_id))\n'})})]})]}),"\n",(0,o.jsx)(n.h2,{id:"externaleventdef",children:(0,o.jsx)(n.code,{children:"ExternalEventDef"})}),"\n",(0,o.jsxs)(n.p,{children:["As of now, the only field required to create an ",(0,o.jsx)(n.code,{children:"ExternalEventDef"})," is the ",(0,o.jsx)(n.code,{children:"name"})," of the ",(0,o.jsx)(n.code,{children:"ExternalEventDef"}),"."]}),"\n",(0,o.jsxs)(s.A,{children:[(0,o.jsxs)(a.A,{value:"java",label:"Java",default:!0,children:[(0,o.jsxs)(n.p,{children:["You can create, get, and delete an ",(0,o.jsx)(n.code,{children:"ExternalEventDef"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.common.proto.DeleteExternalEventDefRequest;\nimport io.littlehorse.sdk.common.proto.ExternalEventDef;\nimport io.littlehorse.sdk.common.proto.ExternalEventDefId;\nimport io.littlehorse.sdk.common.proto.PutExternalEventDefRequest;\n\npublic class Main {\n\n public static void main(String[] args) throws IOException, InterruptedException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n PutExternalEventDefRequest request = PutExternalEventDefRequest.newBuilder()\n .setName("my-external-event-def")\n .build();\n\n client.putExternalEventDef(request);\n\n // Metadata requests in LittleHorse take 50-100 ms to propagate to the global\n // store.\n Thread.sleep(100);\n\n // Retrieve the ExternalEventDef\n ExternalEventDefId id = ExternalEventDefId.newBuilder()\n .setName("my-external-event-def")\n .build();\n ExternalEventDef eventDef = client.getExternalEventDef(id);\n System.out.println(LHLibUtil.protoToJson(eventDef));\n\n // Delete the ExternalEventDef\n DeleteExternalEventDefRequest deleteRequest = DeleteExternalEventDefRequest.newBuilder()\n .setId(id)\n .build();\n client.deleteExternalEventDef(deleteRequest);\n }\n}\n'})})]}),(0,o.jsxs)(a.A,{value:"go",label:"Go",children:[(0,o.jsxs)(n.p,{children:["Assuming that you have a function ",(0,o.jsx)(n.code,{children:"basic.MyWorkflow"})," which is a valid Workflow Function in Go, you can create a ",(0,o.jsx)(n.code,{children:"WfSpec"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\nresp, err := (*client).PutExternalEventDef(context.Background(),\n &lhproto.PutExternalEventDefRequest{\n Name: "some-event",\n },\n)\n'})}),(0,o.jsxs)(n.p,{children:["You can get and delete ",(0,o.jsx)(n.code,{children:"ExternalEventDef"}),"s as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'externalEventDefId := &lhproto.ExternalEventDefId{\n Name: "some-event",\n}\need, err := (*client).GetExternalEventDef(context.Background(), externalEventDefId)\n\n// delete the ExternalEventDef\n_, err = (*client).DeleteExternalEventDef(context.Background(), &lhproto.DeleteExternalEventDefRequest{\n Id: externalEventDefId,\n})\n'})})]}),(0,o.jsxs)(a.A,{value:"python",label:"Python",children:[(0,o.jsxs)(n.p,{children:["In python, you can use the ",(0,o.jsx)(n.code,{children:"littlehorse.create_external_event_def"})," utility to more easily create an ",(0,o.jsx)(n.code,{children:"ExternalEventDef"})," as follows:"]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'from littlehorse import create_external_event_def\nfrom littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom google.protobuf.json_format import MessageToJson\n\nfrom time import sleep\n\n\nif __name__ == \'__main__\':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n create_external_event_def(name="my-external-event-def", config=config)\n\n # In LittleHorse, metadata updates take 50-100ms to propagate to the global\n # store.\n sleep(0.2)\n\n # Fetch the ExternalEventDef\n external_event_def_id = ExternalEventDefId(name="my-external-event-def")\n event_def: ExternalEventDef = client.GetExternalEventDef(external_event_def_id)\n print(MessageToJson(event_def))\n\n # Delete the ExternalEventDef\n client.DeleteExternalEventDef(DeleteExternalEventDefRequest(id=external_event_def_id))\n'})})]})]}),"\n",(0,o.jsx)(n.h2,{id:"usertaskdef",children:(0,o.jsx)(n.code,{children:"UserTaskDef"})}),"\n",(0,o.jsxs)(n.p,{children:["A ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," specifies the data that needs to be filled out in a form for a human to complete a ",(0,o.jsx)(n.code,{children:"UserTaskRun"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Note that a ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," is a versioned object (unlike a ",(0,o.jsx)(n.code,{children:"WfSpec"}),", however, there is only a ",(0,o.jsx)(n.code,{children:"version"})," number and no ",(0,o.jsx)(n.code,{children:"revision"}),"). As such, getting and deleting ",(0,o.jsx)(n.code,{children:"UserTaskDef"}),"s follows a similar pattern: we provide a ",(0,o.jsx)(n.code,{children:"GetLatestUserTaskDef"})," rpc call which allows you to get the latest ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," with a given name."]}),"\n",(0,o.jsxs)(s.A,{children:[(0,o.jsxs)(a.A,{value:"java",label:"Java",default:!0,children:[(0,o.jsxs)(n.p,{children:["The easiest way to create a ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," in Java is using the ",(0,o.jsx)(n.code,{children:"UserTaskSchema"})," class. Note that it infers the schema of the ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," from our ",(0,o.jsx)(n.code,{children:"MyForm"})," class using the ",(0,o.jsx)(n.code,{children:"UserTaskField"})," annotation."]}),(0,o.jsxs)(n.p,{children:["The below example shows you how to create a ",(0,o.jsx)(n.code,{children:"UserTaskDef"}),", get it, and delete it."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.usertask.UserTaskSchema;\nimport io.littlehorse.sdk.usertask.annotations.UserTaskField;\nimport io.littlehorse.sdk.common.proto.DeleteUserTaskDefRequest;\nimport io.littlehorse.sdk.common.proto.PutUserTaskDefRequest;\nimport io.littlehorse.sdk.common.proto.UserTaskDef;\nimport io.littlehorse.sdk.common.proto.UserTaskDefId;\n\n// This Java class defines our form for the UserTaskDef\nclass SomeForm {\n @UserTaskField(\n displayName = "Approved?",\n description = "Reply \'true\' if this is an acceptable request."\n )\n public boolean isApproved;\n\n @UserTaskField(\n displayName = "Explanation",\n description = "Explain your answer",\n required = false\n )\n public String explanation;\n}\n\n\npublic class Main {\n public static void main(String[] args) throws IOException, InterruptedException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n String userTaskDefName = "my-user-task-def";\n\n // Compile the above Java class into a UserTaskDef\n UserTaskSchema userTask = new UserTaskSchema(new SomeForm(), userTaskDefName);\n PutUserTaskDefRequest putRequest = userTask.compile();\n\n // Register the UserTaskDef into LittleHorse\n client.putUserTaskDef(putRequest);\n\n // Get the UserTaskDef. Note that metadata creation takes 50-100ms to propagate\n // through the LittleHorse cluster.\n Thread.sleep(200);\n\n UserTaskDefId id = UserTaskDefId.newBuilder()\n .setName(userTaskDefName)\n .setVersion(0)\n .build();\n UserTaskDef result = client.getUserTaskDef(id);\n System.out.println(LHLibUtil.protoToJson(result));\n\n // Delete the UserTaskDef\n DeleteUserTaskDefRequest deleteRequest = DeleteUserTaskDefRequest.newBuilder()\n .setId(id)\n .build();\n\n client.deleteUserTaskDef(deleteRequest);\n }\n}\n'})})]}),(0,o.jsxs)(a.A,{value:"go",label:"Go",children:[(0,o.jsxs)(n.p,{children:["To create a ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," in Go, you can create the ",(0,o.jsx)(n.code,{children:"PutUserTaskDefRequest"})," object."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-go",children:'config := littlehorse.NewConfigFromEnv()\nclient, err := config.GetGrpcClient()\n\ndescription := "this is a cool usertaskdef!"\nresult, err := (*client).PutUserTaskDef(context.Background(),\n &lhproto.PutUserTaskDefRequest{\n Name: "my-user-task",\n\t\tFields: []*lhproto.UserTaskField{\n\t\t\t&lhproto.UserTaskField{\n\t\t\t\tName: "my-first-int-field",\n\t\t\t\tType: lhproto.VariableType_INT,\n\t\t\t},\n\t\t\t&lhproto.UserTaskField{\n\t\t\t\tName: "my-second-str-field",\n\t\t\t\tType: lhproto.VariableType_STR,\n\t\t\t},\n\t\t},\n\t\tDescription: &description,\n },\n)\n'})})]}),(0,o.jsxs)(a.A,{value:"python",label:"Python",children:[(0,o.jsxs)(n.p,{children:["In python, you can create a ",(0,o.jsx)(n.code,{children:"UserTaskDef"})," using ",(0,o.jsx)(n.a,{href:"/docs/api#putusertaskdef",children:(0,o.jsx)(n.code,{children:"rpc PutUserTaskDef"})}),"."]}),(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:'from littlehorse import create_external_event_def\nfrom littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom google.protobuf.json_format import MessageToJson\n\nfrom time import sleep\n\n\nif __name__ == \'__main__\':\n # Get the grpc client\n config = LHConfig()\n client = config.stub()\n\n # Manually construct the PutUserTaskDefRequest, specifying the fields we want\n # the UserTaskRun\'s to have.\n put_user_task_def_req = PutUserTaskDefRequest(\n name="my-user-task-def",\n fields=[\n UserTaskField(\n name="isApproved",\n description="Is the request Approved?",\n display_name="Approved?",\n required=True,\n ),\n UserTaskField(\n name="explanation",\n description="Explanation or comments for decision.",\n required=False,\n display_name="Comments",\n )\n ]\n )\n\n # Create the UserTaskDef\n client.PutUserTaskDef(put_user_task_def_req)\n\n # Wait for metadata to propagate\n sleep(0.5)\n\n # Get the UserTaskDef\n user_task_def_id = UserTaskDefId(name="my-user-task-def", version=0)\n user_task_def = client.GetUserTaskDef(user_task_def_id)\n print(MessageToJson(user_task_def))\n\n # Delete the UserTaskDef\n client.DeleteUserTaskDef(DeleteUserTaskDefRequest(id=user_task_def_id))\n'})})]})]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(f,{...e})}):f(e)}},9365:(e,n,t)=>{t.d(n,{A:()=>a});t(6540);var o=t(8215);const r={tabItem:"tabItem_Ymn6"};var s=t(4848);function a(e){let{children:n,hidden:t,className:a}=e;return(0,s.jsx)("div",{role:"tabpanel",className:(0,o.A)(r.tabItem,a),hidden:t,children:n})}},1470:(e,n,t)=>{t.d(n,{A:()=>T});var o=t(6540),r=t(8215),s=t(3104),a=t(6347),i=t(205),l=t(7485),c=t(1682),d=t(679);function u(e){return o.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,o.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad PutTaskDef",id:"puttaskdef",level:3},{value:"RPC GetTaskDef",id:"gettaskdef",level:3},{value:"RPC GetTaskWorkerGroup",id:"gettaskworkergroup",level:3},{value:"RPC PutExternalEventDef",id:"putexternaleventdef",level:3},{value:"RPC GetExternalEventDef",id:"getexternaleventdef",level:3},{value:"RPC PutWorkflowEventDef",id:"putworkfloweventdef",level:3},{value:"RPC PutWfSpec",id:"putwfspec",level:3},{value:"RPC GetWfSpec",id:"getwfspec",level:3},{value:"RPC GetLatestWfSpec",id:"getlatestwfspec",level:3},{value:"RPC MigrateWfSpec",id:"migratewfspec",level:3},{value:"RPC PutUserTaskDef",id:"putusertaskdef",level:3},{value:"RPC GetUserTaskDef",id:"getusertaskdef",level:3},{value:"RPC GetLatestUserTaskDef",id:"getlatestusertaskdef",level:3},{value:"RPC RunWf",id:"runwf",level:3},{value:"RPC ScheduleWf",id:"schedulewf",level:3},{value:"RPC SearchScheduledWfRun",id:"searchscheduledwfrun",level:3},{value:"RPC GetScheduledWfRun",id:"getscheduledwfrun",level:3},{value:"RPC GetWfRun",id:"getwfrun",level:3},{value:"RPC GetUserTaskRun",id:"getusertaskrun",level:3},{value:"RPC AssignUserTaskRun",id:"assignusertaskrun",level:3},{value:"RPC CompleteUserTaskRun",id:"completeusertaskrun",level:3},{value:"RPC CancelUserTaskRun",id:"cancelusertaskrun",level:3},{value:"RPC SaveUserTaskRunProgress",id:"saveusertaskrunprogress",level:3},{value:"RPC ListUserTaskRuns",id:"listusertaskruns",level:3},{value:"RPC GetNodeRun",id:"getnoderun",level:3},{value:"RPC ListNodeRuns",id:"listnoderuns",level:3},{value:"RPC GetTaskRun",id:"gettaskrun",level:3},{value:"RPC ListTaskRuns",id:"listtaskruns",level:3},{value:"RPC GetVariable",id:"getvariable",level:3},{value:"RPC ListVariables",id:"listvariables",level:3},{value:"RPC PutExternalEvent",id:"putexternalevent",level:3},{value:"RPC GetExternalEvent",id:"getexternalevent",level:3},{value:"RPC AwaitWorkflowEvent",id:"awaitworkflowevent",level:3},{value:"RPC GetWorkflowEvent",id:"getworkflowevent",level:3},{value:"RPC ListExternalEvents",id:"listexternalevents",level:3},{value:"RPC SearchWfRun",id:"searchwfrun",level:3},{value:"RPC SearchNodeRun",id:"searchnoderun",level:3},{value:"RPC SearchTaskRun",id:"searchtaskrun",level:3},{value:"RPC SearchUserTaskRun",id:"searchusertaskrun",level:3},{value:"RPC SearchVariable",id:"searchvariable",level:3},{value:"RPC SearchExternalEvent",id:"searchexternalevent",level:3},{value:"RPC SearchTaskDef",id:"searchtaskdef",level:3},{value:"RPC SearchUserTaskDef",id:"searchusertaskdef",level:3},{value:"RPC SearchWfSpec",id:"searchwfspec",level:3},{value:"RPC SearchExternalEventDef",id:"searchexternaleventdef",level:3},{value:"RPC SearchTenant",id:"searchtenant",level:3},{value:"RPC SearchPrincipal",id:"searchprincipal",level:3},{value:"RPC RegisterTaskWorker",id:"registertaskworker",level:3},{value:"RPC PollTask",id:"polltask",level:3},{value:"RPC ReportTask",id:"reporttask",level:3},{value:"RPC StopWfRun",id:"stopwfrun",level:3},{value:"RPC ResumeWfRun",id:"resumewfrun",level:3},{value:"RPC RescueThreadRun",id:"rescuethreadrun",level:3},{value:"RPC DeleteWfRun",id:"deletewfrun",level:3},{value:"RPC DeleteTaskDef",id:"deletetaskdef",level:3},{value:"RPC DeleteWfSpec",id:"deletewfspec",level:3},{value:"RPC DeleteUserTaskDef",id:"deleteusertaskdef",level:3},{value:"RPC DeleteExternalEventDef",id:"deleteexternaleventdef",level:3},{value:"RPC DeletePrincipal",id:"deleteprincipal",level:3},{value:"RPC DeleteScheduledWfRun",id:"deletescheduledwfrun",level:3},{value:"RPC GetTaskDefMetricsWindow",id:"gettaskdefmetricswindow",level:3},{value:"RPC GetWfSpecMetricsWindow",id:"getwfspecmetricswindow",level:3},{value:"RPC ListTaskDefMetrics",id:"listtaskdefmetrics",level:3},{value:"RPC ListWfSpecMetrics",id:"listwfspecmetrics",level:3},{value:"RPC PutTenant",id:"puttenant",level:3},{value:"RPC GetTenant",id:"gettenant",level:3},{value:"RPC PutPrincipal",id:"putprincipal",level:3},{value:"RPC Whoami",id:"whoami",level:3},{value:"RPC GetServerVersion",id:"getserverversion",level:3},{value:"LittleHorse Protobuf Schemas",id:"littlehorse-protobuf-schemas",level:2},{value:"Message DeletePrincipalRequest",id:"deleteprincipalrequest",level:3},{value:"Message Principal",id:"principal",level:3},{value:"Message Principal.PerTenantAclsEntry",id:"principalpertenantaclsentry",level:3},{value:"Message PutPrincipalRequest",id:"putprincipalrequest",level:3},{value:"Message PutPrincipalRequest.PerTenantAclsEntry",id:"putprincipalrequestpertenantaclsentry",level:3},{value:"Message PutTenantRequest",id:"puttenantrequest",level:3},{value:"Message ServerACL",id:"serveracl",level:3},{value:"Message ServerACLs",id:"serveracls",level:3},{value:"Message Tenant",id:"tenant",level:3},{value:"Message ExponentialBackoffRetryPolicy",id:"exponentialbackoffretrypolicy",level:3},{value:"Message TaskNode",id:"tasknode",level:3},{value:"Message UTActionTrigger",id:"utactiontrigger",level:3},{value:"Message UTActionTrigger.UTACancel",id:"utactiontriggerutacancel",level:3},{value:"Message UTActionTrigger.UTAReassign",id:"utactiontriggerutareassign",level:3},{value:"Message UTActionTrigger.UTATask",id:"utactiontriggerutatask",level:3},{value:"Message VariableAssignment",id:"variableassignment",level:3},{value:"Message VariableAssignment.FormatString",id:"variableassignmentformatstring",level:3},{value:"Message VariableDef",id:"variabledef",level:3},{value:"Message VariableMutation",id:"variablemutation",level:3},{value:"Message VariableMutation.NodeOutputSource",id:"variablemutationnodeoutputsource",level:3},{value:"Message ExternalEvent",id:"externalevent",level:3},{value:"Message ExternalEventDef",id:"externaleventdef",level:3},{value:"Message ExternalEventRetentionPolicy",id:"externaleventretentionpolicy",level:3},{value:"Message EntrypointRun",id:"entrypointrun",level:3},{value:"Message ExitRun",id:"exitrun",level:3},{value:"Message ExternalEventNodeRun",id:"externaleventnoderun",level:3},{value:"Message Failure",id:"failure",level:3},{value:"Message NodeRun",id:"noderun",level:3},{value:"Message SleepNodeRun",id:"sleepnoderun",level:3},{value:"Message StartMultipleThreadsRun",id:"startmultiplethreadsrun",level:3},{value:"Message StartThreadRun",id:"startthreadrun",level:3},{value:"Message TaskNodeRun",id:"tasknoderun",level:3},{value:"Message ThrowEventNodeRun",id:"throweventnoderun",level:3},{value:"Message UserTaskNodeRun",id:"usertasknoderun",level:3},{value:"Message WaitForConditionRun",id:"waitforconditionrun",level:3},{value:"Message WaitForThreadsRun",id:"waitforthreadsrun",level:3},{value:"Message WaitForThreadsRun.WaitForThread",id:"waitforthreadsrunwaitforthread",level:3},{value:"Message ExternalEventDefId",id:"externaleventdefid",level:3},{value:"Message ExternalEventId",id:"externaleventid",level:3},{value:"Message NodeRunId",id:"noderunid",level:3},{value:"Message PrincipalId",id:"principalid",level:3},{value:"Message ScheduledWfRunId",id:"scheduledwfrunid",level:3},{value:"Message TaskDefId",id:"taskdefid",level:3},{value:"Message TaskDefMetricsId",id:"taskdefmetricsid",level:3},{value:"Message TaskRunId",id:"taskrunid",level:3},{value:"Message TaskWorkerGroupId",id:"taskworkergroupid",level:3},{value:"Message TenantId",id:"tenantid",level:3},{value:"Message UserTaskDefId",id:"usertaskdefid",level:3},{value:"Message UserTaskRunId",id:"usertaskrunid",level:3},{value:"Message VariableId",id:"variableid",level:3},{value:"Message WfRunId",id:"wfrunid",level:3},{value:"Message WfSpecId",id:"wfspecid",level:3},{value:"Message WfSpecMetricsId",id:"wfspecmetricsid",level:3},{value:"Message WorkflowEventDefId",id:"workfloweventdefid",level:3},{value:"Message WorkflowEventId",id:"workfloweventid",level:3},{value:"Message ScheduledWfRun",id:"scheduledwfrun",level:3},{value:"Message ScheduledWfRun.VariablesEntry",id:"scheduledwfrunvariablesentry",level:3},{value:"Message AwaitWorkflowEventRequest",id:"awaitworkfloweventrequest",level:3},{value:"Message DeleteExternalEventDefRequest",id:"deleteexternaleventdefrequest",level:3},{value:"Message DeleteExternalEventRequest",id:"deleteexternaleventrequest",level:3},{value:"Message DeleteScheduledWfRunRequest",id:"deletescheduledwfrunrequest",level:3},{value:"Message DeleteTaskDefRequest",id:"deletetaskdefrequest",level:3},{value:"Message DeleteUserTaskDefRequest",id:"deleteusertaskdefrequest",level:3},{value:"Message DeleteWfRunRequest",id:"deletewfrunrequest",level:3},{value:"Message DeleteWfSpecRequest",id:"deletewfspecrequest",level:3},{value:"Message ExternalEventDefIdList",id:"externaleventdefidlist",level:3},{value:"Message ExternalEventIdList",id:"externaleventidlist",level:3},{value:"Message ExternalEventList",id:"externaleventlist",level:3},{value:"Message GetLatestUserTaskDefRequest",id:"getlatestusertaskdefrequest",level:3},{value:"Message GetLatestWfSpecRequest",id:"getlatestwfspecrequest",level:3},{value:"Message LHHostInfo",id:"lhhostinfo",level:3},{value:"Message ListExternalEventsRequest",id:"listexternaleventsrequest",level:3},{value:"Message ListNodeRunsRequest",id:"listnoderunsrequest",level:3},{value:"Message ListTaskMetricsRequest",id:"listtaskmetricsrequest",level:3},{value:"Message ListTaskMetricsResponse",id:"listtaskmetricsresponse",level:3},{value:"Message ListTaskRunsRequest",id:"listtaskrunsrequest",level:3},{value:"Message ListUserTaskRunRequest",id:"listusertaskrunrequest",level:3},{value:"Message ListVariablesRequest",id:"listvariablesrequest",level:3},{value:"Message ListWfMetricsRequest",id:"listwfmetricsrequest",level:3},{value:"Message ListWfMetricsResponse",id:"listwfmetricsresponse",level:3},{value:"Message MigrateWfSpecRequest",id:"migratewfspecrequest",level:3},{value:"Message NodeRunIdList",id:"noderunidlist",level:3},{value:"Message NodeRunList",id:"noderunlist",level:3},{value:"Message PollTaskRequest",id:"polltaskrequest",level:3},{value:"Message PollTaskResponse",id:"polltaskresponse",level:3},{value:"Message PrincipalIdList",id:"principalidlist",level:3},{value:"Message PutExternalEventDefRequest",id:"putexternaleventdefrequest",level:3},{value:"Message PutExternalEventRequest",id:"putexternaleventrequest",level:3},{value:"Message PutTaskDefRequest",id:"puttaskdefrequest",level:3},{value:"Message PutUserTaskDefRequest",id:"putusertaskdefrequest",level:3},{value:"Message PutWfSpecRequest",id:"putwfspecrequest",level:3},{value:"Message PutWfSpecRequest.ThreadSpecsEntry",id:"putwfspecrequestthreadspecsentry",level:3},{value:"Message PutWorkflowEventDefRequest",id:"putworkfloweventdefrequest",level:3},{value:"Message RegisterTaskWorkerRequest",id:"registertaskworkerrequest",level:3},{value:"Message RegisterTaskWorkerResponse",id:"registertaskworkerresponse",level:3},{value:"Message ReportTaskRun",id:"reporttaskrun",level:3},{value:"Message RescueThreadRunRequest",id:"rescuethreadrunrequest",level:3},{value:"Message ResumeWfRunRequest",id:"resumewfrunrequest",level:3},{value:"Message RunWfRequest",id:"runwfrequest",level:3},{value:"Message RunWfRequest.VariablesEntry",id:"runwfrequestvariablesentry",level:3},{value:"Message ScheduleWfRequest",id:"schedulewfrequest",level:3},{value:"Message ScheduleWfRequest.VariablesEntry",id:"schedulewfrequestvariablesentry",level:3},{value:"Message ScheduledTask",id:"scheduledtask",level:3},{value:"Message ScheduledWfRunIdList",id:"scheduledwfrunidlist",level:3},{value:"Message SearchExternalEventDefRequest",id:"searchexternaleventdefrequest",level:3},{value:"Message SearchExternalEventRequest",id:"searchexternaleventrequest",level:3},{value:"Message SearchNodeRunRequest",id:"searchnoderunrequest",level:3},{value:"Message SearchPrincipalRequest",id:"searchprincipalrequest",level:3},{value:"Message SearchScheduledWfRunRequest",id:"searchscheduledwfrunrequest",level:3},{value:"Message SearchTaskDefRequest",id:"searchtaskdefrequest",level:3},{value:"Message SearchTaskRunRequest",id:"searchtaskrunrequest",level:3},{value:"Message SearchTenantRequest",id:"searchtenantrequest",level:3},{value:"Message SearchUserTaskDefRequest",id:"searchusertaskdefrequest",level:3},{value:"Message SearchUserTaskRunRequest",id:"searchusertaskrunrequest",level:3},{value:"Message SearchVariableRequest",id:"searchvariablerequest",level:3},{value:"Message SearchWfRunRequest",id:"searchwfrunrequest",level:3},{value:"Message SearchWfSpecRequest",id:"searchwfspecrequest",level:3},{value:"Message ServerVersionResponse",id:"serverversionresponse",level:3},{value:"Message StopWfRunRequest",id:"stopwfrunrequest",level:3},{value:"Message TaskDefIdList",id:"taskdefidlist",level:3},{value:"Message TaskDefMetrics",id:"taskdefmetrics",level:3},{value:"Message TaskDefMetricsQueryRequest",id:"taskdefmetricsqueryrequest",level:3},{value:"Message TaskRunIdList",id:"taskrunidlist",level:3},{value:"Message TaskRunList",id:"taskrunlist",level:3},{value:"Message TaskWorkerGroup",id:"taskworkergroup",level:3},{value:"Message TaskWorkerGroup.TaskWorkersEntry",id:"taskworkergrouptaskworkersentry",level:3},{value:"Message TaskWorkerHeartBeatRequest",id:"taskworkerheartbeatrequest",level:3},{value:"Message TaskWorkerMetadata",id:"taskworkermetadata",level:3},{value:"Message TenantIdList",id:"tenantidlist",level:3},{value:"Message UserTaskDefIdList",id:"usertaskdefidlist",level:3},{value:"Message UserTaskRunIdList",id:"usertaskrunidlist",level:3},{value:"Message UserTaskRunList",id:"usertaskrunlist",level:3},{value:"Message VariableIdList",id:"variableidlist",level:3},{value:"Message VariableList",id:"variablelist",level:3},{value:"Message VariableMatch",id:"variablematch",level:3},{value:"Message WfRunIdList",id:"wfrunidlist",level:3},{value:"Message WfSpecIdList",id:"wfspecidlist",level:3},{value:"Message WfSpecMetrics",id:"wfspecmetrics",level:3},{value:"Message WfSpecMetricsQueryRequest",id:"wfspecmetricsqueryrequest",level:3},{value:"Message TaskDef",id:"taskdef",level:3},{value:"Message TaskDefOutputSchema",id:"taskdefoutputschema",level:3},{value:"Message LHTaskError",id:"lhtaskerror",level:3},{value:"Message LHTaskException",id:"lhtaskexception",level:3},{value:"Message TaskAttempt",id:"taskattempt",level:3},{value:"Message TaskNodeReference",id:"tasknodereference",level:3},{value:"Message TaskRun",id:"taskrun",level:3},{value:"Message TaskRunSource",id:"taskrunsource",level:3},{value:"Message VarNameAndVal",id:"varnameandval",level:3},{value:"Message AssignUserTaskRunRequest",id:"assignusertaskrunrequest",level:3},{value:"Message CancelUserTaskRunRequest",id:"cancelusertaskrunrequest",level:3},{value:"Message CompleteUserTaskRunRequest",id:"completeusertaskrunrequest",level:3},{value:"Message CompleteUserTaskRunRequest.ResultsEntry",id:"completeusertaskrunrequestresultsentry",level:3},{value:"Message SaveUserTaskRunProgressRequest",id:"saveusertaskrunprogressrequest",level:3},{value:"Message SaveUserTaskRunProgressRequest.ResultsEntry",id:"saveusertaskrunprogressrequestresultsentry",level:3},{value:"Message UserTaskDef",id:"usertaskdef",level:3},{value:"Message UserTaskEvent",id:"usertaskevent",level:3},{value:"Message UserTaskEvent.UTEAssigned",id:"usertaskeventuteassigned",level:3},{value:"Message UserTaskEvent.UTECancelled",id:"usertaskeventutecancelled",level:3},{value:"Message UserTaskEvent.UTESaved",id:"usertaskeventutesaved",level:3},{value:"Message UserTaskEvent.UTESaved.ResultsEntry",id:"usertaskeventutesavedresultsentry",level:3},{value:"Message UserTaskEvent.UTETaskExecuted",id:"usertaskeventutetaskexecuted",level:3},{value:"Message UserTaskField",id:"usertaskfield",level:3},{value:"Message UserTaskRun",id:"usertaskrun",level:3},{value:"Message UserTaskRun.ResultsEntry",id:"usertaskrunresultsentry",level:3},{value:"Message UserTaskTriggerReference",id:"usertasktriggerreference",level:3},{value:"Message Variable",id:"variable",level:3},{value:"Message VariableValue",id:"variablevalue",level:3},{value:"Message FailureBeingHandled",id:"failurebeinghandled",level:3},{value:"Message HandlingFailureHaltReason",id:"handlingfailurehaltreason",level:3},{value:"Message Interrupted",id:"interrupted",level:3},{value:"Message ManualHalt",id:"manualhalt",level:3},{value:"Message ParentHalted",id:"parenthalted",level:3},{value:"Message PendingFailureHandler",id:"pendingfailurehandler",level:3},{value:"Message PendingFailureHandlerHaltReason",id:"pendingfailurehandlerhaltreason",level:3},{value:"Message PendingInterrupt",id:"pendinginterrupt",level:3},{value:"Message PendingInterruptHaltReason",id:"pendinginterrupthaltreason",level:3},{value:"Message ThreadHaltReason",id:"threadhaltreason",level:3},{value:"Message ThreadRun",id:"threadrun",level:3},{value:"Message WfRun",id:"wfrun",level:3},{value:"Message Edge",id:"edge",level:3},{value:"Message EdgeCondition",id:"edgecondition",level:3},{value:"Message EntrypointNode",id:"entrypointnode",level:3},{value:"Message ExitNode",id:"exitnode",level:3},{value:"Message ExternalEventNode",id:"externaleventnode",level:3},{value:"Message FailureDef",id:"failuredef",level:3},{value:"Message FailureHandlerDef",id:"failurehandlerdef",level:3},{value:"Message InterruptDef",id:"interruptdef",level:3},{value:"Message JsonIndex",id:"jsonindex",level:3},{value:"Message Node",id:"node",level:3},{value:"Message NodeMigration",id:"nodemigration",level:3},{value:"Message NopNode",id:"nopnode",level:3},{value:"Message SleepNode",id:"sleepnode",level:3},{value:"Message StartMultipleThreadsNode",id:"startmultiplethreadsnode",level:3},{value:"Message StartMultipleThreadsNode.VariablesEntry",id:"startmultiplethreadsnodevariablesentry",level:3},{value:"Message StartThreadNode",id:"startthreadnode",level:3},{value:"Message StartThreadNode.VariablesEntry",id:"startthreadnodevariablesentry",level:3},{value:"Message ThreadRetentionPolicy",id:"threadretentionpolicy",level:3},{value:"Message ThreadSpec",id:"threadspec",level:3},{value:"Message ThreadSpec.NodesEntry",id:"threadspecnodesentry",level:3},{value:"Message ThreadSpecMigration",id:"threadspecmigration",level:3},{value:"Message ThreadSpecMigration.NodeMigrationsEntry",id:"threadspecmigrationnodemigrationsentry",level:3},{value:"Message ThreadVarDef",id:"threadvardef",level:3},{value:"Message ThrowEventNode",id:"throweventnode",level:3},{value:"Message UserTaskNode",id:"usertasknode",level:3},{value:"Message WaitForConditionNode",id:"waitforconditionnode",level:3},{value:"Message WaitForThreadsNode",id:"waitforthreadsnode",level:3},{value:"Message WaitForThreadsNode.ThreadToWaitFor",id:"waitforthreadsnodethreadtowaitfor",level:3},{value:"Message WaitForThreadsNode.ThreadsToWaitFor",id:"waitforthreadsnodethreadstowaitfor",level:3},{value:"Message WfSpec",id:"wfspec",level:3},{value:"Message WfSpec.ParentWfSpecReference",id:"wfspecparentwfspecreference",level:3},{value:"Message WfSpec.ThreadSpecsEntry",id:"wfspecthreadspecsentry",level:3},{value:"Message WfSpecVersionMigration",id:"wfspecversionmigration",level:3},{value:"Message WfSpecVersionMigration.ThreadSpecMigrationsEntry",id:"wfspecversionmigrationthreadspecmigrationsentry",level:3},{value:"Message WorkflowRetentionPolicy",id:"workflowretentionpolicy",level:3},{value:"Message WorkflowEvent",id:"workflowevent",level:3},{value:"Message WorkflowEventDef",id:"workfloweventdef",level:3},{value:"LittleHorse Enums",id:"littlehorse-enums",level:2},{value:"Enum ACLAction",id:"aclaction",level:3},{value:"Enum ACLResource",id:"aclresource",level:3},{value:"Enum LHErrorType",id:"lherrortype",level:3},{value:"Enum LHStatus",id:"lhstatus",level:3},{value:"Enum MetadataStatus",id:"metadatastatus",level:3},{value:"Enum MetricsWindowLength",id:"metricswindowlength",level:3},{value:"Enum TaskStatus",id:"taskstatus",level:3},{value:"Enum VariableType",id:"variabletype",level:3},{value:"Enum Comparator",id:"comparator",level:3},{value:"Enum UTActionTrigger.UTHook",id:"utactiontriggeruthook",level:3},{value:"Enum VariableMutationType",id:"variablemutationtype",level:3},{value:"Enum WaitForThreadsRun.WaitingThreadStatus",id:"waitforthreadsrunwaitingthreadstatus",level:3},{value:"Enum AllowedUpdateType",id:"allowedupdatetype",level:3},{value:"Enum SearchNodeRunRequest.NodeType",id:"searchnoderunrequestnodetype",level:3},{value:"Enum SaveUserTaskRunProgressRequest.SaveUserTaskRunAssignmentPolicy",id:"saveusertaskrunprogressrequestsaveusertaskrunassignmentpolicy",level:3},{value:"Enum UserTaskRunStatus",id:"usertaskrunstatus",level:3},{value:"Enum ThreadType",id:"threadtype",level:3},{value:"Enum FailureHandlerDef.LHFailureType",id:"failurehandlerdeflhfailuretype",level:3},{value:"Enum WfRunVariableAccessLevel",id:"wfrunvariableaccesslevel",level:3}];function a(e){const s={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"littlehorse-api-reference",children:"LittleHorse API Reference"})}),"\n",(0,r.jsxs)(s.p,{children:["The LittleHorse Server exposes a GRPC API to its clients. For most general usage of LittleHorse, you ",(0,r.jsx)(s.em,{children:"will not"})," need to\nread the raw protobuf schema. Common LittleHorse client actions fall into three general categories:"]}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsxs)(s.li,{children:["Developing a Task Worker, which is handled by our ",(0,r.jsx)(s.a,{href:"/docs/developer-guide/task-worker-development",children:"Task Worker SDK's"}),"."]}),"\n",(0,r.jsxs)(s.li,{children:["Developing a WfSpec, which is handled by our ",(0,r.jsxs)(s.a,{href:"/docs/developer-guide/wfspec-development",children:[(0,r.jsx)(s.code,{children:"WfSpec"})," SDK's"]}),"."]}),"\n",(0,r.jsxs)(s.li,{children:["Running and interacting with ",(0,r.jsx)(s.code,{children:"WfRun"}),"'s, which is documented in our ",(0,r.jsx)(s.a,{href:"/docs/developer-guide/grpc",children:'"Using the API"'})," docs."]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["However, the highly curious reader might want to see the actual GRPC and Protobuf specification. The docs on this page\nare autogenerated from our actual ",(0,r.jsx)(s.a,{href:"https://github.com/littlehorse-enterprises/littlehorse/tree/master/schemas",children:"protobuf files"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"The documentation of what the specific protobuf fields mean is potentially useful for advanced Jedi Master use-cases."}),"\n",(0,r.jsx)(s.p,{children:"Happy Reading!"}),"\n",(0,r.jsx)(s.h2,{id:"littlehorse-grpc-api",children:"LittleHorse GRPC API"}),"\n",(0,r.jsxs)(s.p,{children:["The LittleHorse GRPC API is the backbone of the clients that you get in all of our SDK's. Every ",(0,r.jsx)(s.code,{children:"LHConfig"})," object\ngives you a GRPC stub to access the API. Most common operations are already documented with code examples in different\nlanguages ",(0,r.jsx)(s.a,{href:"/docs/developer-guide/grpc",children:"here"}),", but we put this here for the true Jedi Masters."]}),"\n",(0,r.jsxs)(s.h3,{id:"puttaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"PutTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#puttaskdefrequest",children:"PutTaskDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdef",children:"TaskDef"})}),(0,r.jsx)(s.td,{children:"Creates a TaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"gettaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"GetTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdef",children:"TaskDef"})}),(0,r.jsx)(s.td,{children:"Gets a TaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"gettaskworkergroup",children:["RPC ",(0,r.jsx)(s.code,{children:"GetTaskWorkerGroup"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskworkergroup",children:"TaskWorkerGroup"})}),(0,r.jsx)(s.td,{children:"Gets the registered task worker group associated with a specific TaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putexternaleventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"PutExternalEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putexternaleventdefrequest",children:"PutExternalEventDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdef",children:"ExternalEventDef"})}),(0,r.jsx)(s.td,{children:"Creates an ExternalEventDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getexternaleventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"GetExternalEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdef",children:"ExternalEventDef"})}),(0,r.jsx)(s.td,{children:"Gets an ExternalEventDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putworkfloweventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"PutWorkflowEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putworkfloweventdefrequest",children:"PutWorkflowEventDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdef",children:"WorkflowEventDef"})}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: Creates a WorkflowEventDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putwfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"PutWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putwfspecrequest",children:"PutWfSpecRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspec",children:"WfSpec"})}),(0,r.jsx)(s.td,{children:"Creates a WfSpec."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getwfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"GetWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspec",children:"WfSpec"})}),(0,r.jsx)(s.td,{children:"Gets a WfSpec."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getlatestwfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"GetLatestWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#getlatestwfspecrequest",children:"GetLatestWfSpecRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspec",children:"WfSpec"})}),(0,r.jsx)(s.td,{children:"Returns the latest WfSpec with a specified name (and optionally a specified Major Version)."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"migratewfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"MigrateWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#migratewfspecrequest",children:"MigrateWfSpecRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspec",children:"WfSpec"})}),(0,r.jsxs)(s.td,{children:["EXPERIMENTAL: Migrates all WfRun's from one version of a WfSpec onto a newer version of the same WfSpec. This is useful for long-running WfRun's (eg. a 60-day marketing campaign) where you must update WfRun's that are in the RUNNING state rather than allowing them to run to completion.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"As of 0.7.2, this feature is only partially implemented."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putusertaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"PutUserTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putusertaskdefrequest",children:"PutUserTaskDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdef",children:"UserTaskDef"})}),(0,r.jsx)(s.td,{children:"Creates a UserTaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getusertaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"GetUserTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdefid",children:"UserTaskDefId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdef",children:"UserTaskDef"})}),(0,r.jsxs)(s.td,{children:["Gets a specific UserTaskDef.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"This RPC is highly useful for applications built around User Tasks. For example, a UI that dynamically displays form fields based on the User Task might first receive a UserTaskRun, then use that UserTaskRun to look up the UserTaskDef. The frontend would inspect the UserTaskDef and display a form field on the browser page for each field in the UserTaskDef."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getlatestusertaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"GetLatestUserTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#getlatestusertaskdefrequest",children:"GetLatestUserTaskDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdef",children:"UserTaskDef"})}),(0,r.jsx)(s.td,{children:"Returns the most recent UserTaskDef with a specific name."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"runwf",children:["RPC ",(0,r.jsx)(s.code,{children:"RunWf"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#runwfrequest",children:"RunWfRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrun",children:"WfRun"})}),(0,r.jsx)(s.td,{children:"Runs a WfSpec to create a WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"schedulewf",children:["RPC ",(0,r.jsx)(s.code,{children:"ScheduleWf"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#schedulewfrequest",children:"ScheduleWfRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrun",children:"ScheduledWfRun"})}),(0,r.jsx)(s.td,{children:"Schedule repeated WfRun based on a cron expression"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchscheduledwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchScheduledWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchscheduledwfrunrequest",children:"SearchScheduledWfRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunidlist",children:"ScheduledWfRunIdList"})}),(0,r.jsx)(s.td,{children:"Search for existing schedules"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getscheduledwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"GetScheduledWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunid",children:"ScheduledWfRunId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrun",children:"ScheduledWfRun"})}),(0,r.jsx)(s.td,{children:"Find a specific ScheduledWfRun"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"GetWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrun",children:"WfRun"})}),(0,r.jsx)(s.td,{children:"Gets a WfRun. Although useful for development and debugging, this RPC is not often used by applications."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getusertaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"GetUserTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrun",children:"UserTaskRun"})}),(0,r.jsx)(s.td,{children:"Loads a specific UserTaskRun. It includes information about to whom the UserTask is currently assigned, history of assignments and reassignments, and any context for that UserTaskRun which is specific to the WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"assignusertaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"AssignUserTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#assignusertaskrunrequest",children:"AssignUserTaskRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Change the ownership of a UserTaskRun to a new userId, userGroup, or both. The action will be reflected in your next call to SearchUserTaskRun. This RPC is useful for applications that are using User Tasks to build an internal task-list and wish to administer the tasks."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"completeusertaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"CompleteUserTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#completeusertaskrunrequest",children:"CompleteUserTaskRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsxs)(s.td,{children:["Completes a UserTaskRun. Includes the results of the UserTaskRun, the UserTaskRun Id, and the userId of the user who completes the UserTaskRun. Results in the UserTask NodeRun being completed, and unblocks the associated ThreadRun in the WfRun.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"This RPC is highly useful for applications built around a WfSpec that uses USER_TASK nodes."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"cancelusertaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"CancelUserTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#cancelusertaskrunrequest",children:"CancelUserTaskRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Cancels a UserTaskRun. This will result in an EXCEPTION being propagated to the WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"saveusertaskrunprogress",children:["RPC ",(0,r.jsx)(s.code,{children:"SaveUserTaskRunProgress"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#saveusertaskrunprogressrequest",children:"SaveUserTaskRunProgressRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrun",children:"UserTaskRun"})}),(0,r.jsxs)(s.td,{children:["Saves the results of a UserTaskRun and logs who saved the content.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),(0,r.jsxs)("li",{children:[" Throws FAILED_PRECONDITION if the UserTaskRun is in the ",(0,r.jsx)(s.code,{children:"DONE"})," or ",(0,r.jsx)(s.code,{children:"CANCELLED"})," state."]})," ",(0,r.jsxs)("li",{children:[" If ",(0,r.jsx)(s.code,{children:"policy"})," is set to ",(0,r.jsx)(s.code,{children:"FAIL_IF_CLAIMED_BY_OTHER"}),", returns ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"})," if the ",(0,r.jsx)(s.code,{children:"user_id"})," field of the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," does not match the ",(0,r.jsx)(s.code,{children:"user_id"})," of the request."]})]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listusertaskruns",children:["RPC ",(0,r.jsx)(s.code,{children:"ListUserTaskRuns"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listusertaskrunrequest",children:"ListUserTaskRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunlist",children:"UserTaskRunList"})}),(0,r.jsx)(s.td,{children:"Lists all UserTaskRun's for a specific WfRun. Can be useful when using a WfRun to model an entity."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getnoderun",children:["RPC ",(0,r.jsx)(s.code,{children:"GetNodeRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderun",children:"NodeRun"})}),(0,r.jsx)(s.td,{children:"Gets a specific NodeRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listnoderuns",children:["RPC ",(0,r.jsx)(s.code,{children:"ListNodeRuns"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listnoderunsrequest",children:"ListNodeRunsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunlist",children:"NodeRunList"})}),(0,r.jsx)(s.td,{children:"Lists all NodeRun's for a specific WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"gettaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"GetTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrun",children:"TaskRun"})}),(0,r.jsx)(s.td,{children:"Gets a specific TaskRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listtaskruns",children:["RPC ",(0,r.jsx)(s.code,{children:"ListTaskRuns"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listtaskrunsrequest",children:"ListTaskRunsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunlist",children:"TaskRunList"})}),(0,r.jsx)(s.td,{children:"Lists all TaskRun's for a specific WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getvariable",children:["RPC ",(0,r.jsx)(s.code,{children:"GetVariable"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableid",children:"VariableId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variable",children:"Variable"})}),(0,r.jsx)(s.td,{children:"Get the value of a specific Variable. When using a WfRun to model an entity, this RPC is useful for retrieving information. It is equivalent to looking up the value of a column for a specific row in a SQL table."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listvariables",children:["RPC ",(0,r.jsx)(s.code,{children:"ListVariables"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listvariablesrequest",children:"ListVariablesRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablelist",children:"VariableList"})}),(0,r.jsx)(s.td,{children:"List all Variables from a WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putexternalevent",children:["RPC ",(0,r.jsx)(s.code,{children:"PutExternalEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putexternaleventrequest",children:"PutExternalEventRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externalevent",children:"ExternalEvent"})}),(0,r.jsx)(s.td,{children:"Post an ExternalEvent. This RPC is highly useful for"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getexternalevent",children:["RPC ",(0,r.jsx)(s.code,{children:"GetExternalEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externalevent",children:"ExternalEvent"})}),(0,r.jsx)(s.td,{children:"Get a specific ExternalEvent."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"awaitworkflowevent",children:["RPC ",(0,r.jsx)(s.code,{children:"AwaitWorkflowEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#awaitworkfloweventrequest",children:"AwaitWorkflowEventRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workflowevent",children:"WorkflowEvent"})}),(0,r.jsxs)(s.td,{children:["Waits for a WorkflowEvent to be thrown by a given WfRun. Returns immediately if a matching WorkflowEvent has already been thrown; throws a DEADLINE_EXCEEDED error if the WorkflowEvent is not thrown before the deadline specified by the client.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"To specify the deadline, the client should use GRPC deadlines."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getworkflowevent",children:["RPC ",(0,r.jsx)(s.code,{children:"GetWorkflowEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventid",children:"WorkflowEventId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workflowevent",children:"WorkflowEvent"})}),(0,r.jsx)(s.td,{children:"Get a specific WorkflowEvent."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listexternalevents",children:["RPC ",(0,r.jsx)(s.code,{children:"ListExternalEvents"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listexternaleventsrequest",children:"ListExternalEventsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventlist",children:"ExternalEventList"})}),(0,r.jsx)(s.td,{children:"List ExternalEvent's for a specific WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchwfrunrequest",children:"SearchWfRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunidlist",children:"WfRunIdList"})}),(0,r.jsx)(s.td,{children:"Search for WfRun's. This RPC is highly useful for applications that store data in LittleHorse and need to find a specific WfRun based on certain indexed fields."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchnoderun",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchNodeRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchnoderunrequest",children:"SearchNodeRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunidlist",children:"NodeRunIdList"})}),(0,r.jsx)(s.td,{children:"Search for NodeRun's. This RPC is useful for monitoring and finding bugs in your workflows or Task Workers."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchtaskrunrequest",children:"SearchTaskRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunidlist",children:"TaskRunIdList"})}),(0,r.jsx)(s.td,{children:"Search for TaskRun's. This RPC is useful for finding bugs in your Task Workers."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchusertaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchUserTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchusertaskrunrequest",children:"SearchUserTaskRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunidlist",children:"UserTaskRunIdList"})}),(0,r.jsx)(s.td,{children:"Search for UserTaskRun's. This RPC is highly useful for applications that connect human end-users to LittleHorse: it enables you to find all tasks assigned to a specific person or group of people."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchvariable",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchVariable"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchvariablerequest",children:"SearchVariableRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableidlist",children:"VariableIdList"})}),(0,r.jsx)(s.td,{children:"Search for Variable's. This RPC is highly useful for applications that store data in LittleHorse and need to find a specific WfRun based on certain indexed fields."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchexternalevent",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchExternalEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchexternaleventrequest",children:"SearchExternalEventRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventidlist",children:"ExternalEventIdList"})}),(0,r.jsx)(s.td,{children:"Search for ExternalEvent's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchtaskdefrequest",children:"SearchTaskDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefidlist",children:"TaskDefIdList"})}),(0,r.jsx)(s.td,{children:"Search for TaskDef's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchusertaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchUserTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchusertaskdefrequest",children:"SearchUserTaskDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdefidlist",children:"UserTaskDefIdList"})}),(0,r.jsx)(s.td,{children:"Search for UserTaskDef's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchwfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchwfspecrequest",children:"SearchWfSpecRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecidlist",children:"WfSpecIdList"})}),(0,r.jsx)(s.td,{children:"Search for WfSpec's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchexternaleventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchExternalEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchexternaleventdefrequest",children:"SearchExternalEventDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefidlist",children:"ExternalEventDefIdList"})}),(0,r.jsx)(s.td,{children:"Search for ExternalEventDef's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtenant",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchTenant"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchtenantrequest",children:"SearchTenantRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenantidlist",children:"TenantIdList"})}),(0,r.jsx)(s.td,{children:"Search for all available TenantIds for current Principal"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchprincipal",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchPrincipal"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchprincipalrequest",children:"SearchPrincipalRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principalidlist",children:"PrincipalIdList"})}),(0,r.jsx)(s.td,{})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"registertaskworker",children:["RPC ",(0,r.jsx)(s.code,{children:"RegisterTaskWorker"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#registertaskworkerrequest",children:"RegisterTaskWorkerRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#registertaskworkerresponse",children:"RegisterTaskWorkerResponse"})}),(0,r.jsx)(s.td,{children:"Used by the Task Worker to: 1. Tell the LH Server that the Task Worker has joined the Task Worker Group. 2. Receive the assignemnt of LH Server's to poll from. Generally, you won't use this request manually."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"polltask",children:["RPC ",(0,r.jsx)(s.code,{children:"PollTask"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#polltaskrequest",children:"PollTaskRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#polltaskresponse",children:"PollTaskResponse"})}),(0,r.jsx)(s.td,{children:"Used by Task Workers to listen for TaskRuns on the Task Queue. Generally, you won't use this RPC manually."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"reporttask",children:["RPC ",(0,r.jsx)(s.code,{children:"ReportTask"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#reporttaskrun",children:"ReportTaskRun"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Used by Task Workers to report the result of a TaskRun. Generally, you won't use this rpc manually."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"stopwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"StopWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#stopwfrunrequest",children:"StopWfRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Move a WfRun or a specific ThreadRun in that WfRun to the HALTED state."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"resumewfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"ResumeWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#resumewfrunrequest",children:"ResumeWfRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Resumes a WfRun or a specific ThreadRun of a WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"rescuethreadrun",children:["RPC ",(0,r.jsx)(s.code,{children:"RescueThreadRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#rescuethreadrunrequest",children:"RescueThreadRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrun",children:"WfRun"})}),(0,r.jsxs)(s.td,{children:["Rescues a failed ThreadRun (in the ERROR state only) by restarting it from the point of failure. Useful if a bug in Task Worker implementation caused a WfRun to fail and you did not have a FailureHandler for that NodeRun.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"The specified ",(0,r.jsx)(s.code,{children:"ThreadRun"})," must be in a state where it's latest ",(0,r.jsx)(s.code,{children:"NodeRun"})," is: ",(0,r.jsx)("br",{})," - In the ",(0,r.jsx)(s.code,{children:"ERROR"})," state.",(0,r.jsx)("br",{})," - Has no ",(0,r.jsx)(s.code,{children:"FailureHandler"})," ",(0,r.jsx)(s.code,{children:"ThreadRun"}),"s ",(0,r.jsx)("br",{})," - The parent ",(0,r.jsx)(s.code,{children:"ThreadRun"}),", or any parent of the parent, has not handled the ",(0,r.jsx)(s.code,{children:"Failure"})," yet.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If that is not true, then the ",(0,r.jsx)(s.code,{children:"ThreadRun"})," cannot be rescued and the request will return ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"}),"."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletewfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deletewfrunrequest",children:"DeleteWfRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes a WfRun. The WfRun cannot be in the RUNNING state."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletetaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deletetaskdefrequest",children:"DeleteTaskDefRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes a TaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletewfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deletewfspecrequest",children:"DeleteWfSpecRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes a WfSpec."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteusertaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteUserTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deleteusertaskdefrequest",children:"DeleteUserTaskDefRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes a UserTaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteexternaleventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteExternalEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deleteexternaleventdefrequest",children:"DeleteExternalEventDefRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes an ExternalEventDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteprincipal",children:["RPC ",(0,r.jsx)(s.code,{children:"DeletePrincipal"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deleteprincipalrequest",children:"DeletePrincipalRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsxs)(s.td,{children:["Deletes a ",(0,r.jsx)(s.code,{children:"Principal"}),". Fails with ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"})," if the specified ",(0,r.jsx)(s.code,{children:"Principal"})," is the last remaining ",(0,r.jsx)(s.code,{children:"Principal"})," with admin permissions. Admin permissions are defined as having the ",(0,r.jsx)(s.code,{children:"global_acls"})," of ",(0,r.jsx)(s.code,{children:"ALL_ACTIONS"})," over the ",(0,r.jsx)(s.code,{children:"ACL_ALL_RESOURCES"})," scope."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletescheduledwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteScheduledWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deletescheduledwfrunrequest",children:"DeleteScheduledWfRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes a scheduled run and prevents any further associated WfRun from being executed."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"gettaskdefmetricswindow",children:["RPC ",(0,r.jsx)(s.code,{children:"GetTaskDefMetricsWindow"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefmetricsqueryrequest",children:"TaskDefMetricsQueryRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefmetrics",children:"TaskDefMetrics"})}),(0,r.jsx)(s.td,{children:"Returns TaskDef Metrics for a specific TaskDef and a specific time window."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getwfspecmetricswindow",children:["RPC ",(0,r.jsx)(s.code,{children:"GetWfSpecMetricsWindow"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecmetricsqueryrequest",children:"WfSpecMetricsQueryRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecmetrics",children:"WfSpecMetrics"})}),(0,r.jsx)(s.td,{children:"Returns WfSpec Metrics for a specific WfSpec and a specific time window."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listtaskdefmetrics",children:["RPC ",(0,r.jsx)(s.code,{children:"ListTaskDefMetrics"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listtaskmetricsrequest",children:"ListTaskMetricsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listtaskmetricsresponse",children:"ListTaskMetricsResponse"})}),(0,r.jsx)(s.td,{children:"Returns a list of TaskDef Metrics Windows."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listwfspecmetrics",children:["RPC ",(0,r.jsx)(s.code,{children:"ListWfSpecMetrics"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listwfmetricsrequest",children:"ListWfMetricsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listwfmetricsresponse",children:"ListWfMetricsResponse"})}),(0,r.jsx)(s.td,{children:"Returns a list of WfSpec Metrics Windows."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"puttenant",children:["RPC ",(0,r.jsx)(s.code,{children:"PutTenant"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#puttenantrequest",children:"PutTenantRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenant",children:"Tenant"})}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: Creates another Tenant in the LH Server."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"gettenant",children:["RPC ",(0,r.jsx)(s.code,{children:"GetTenant"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenantid",children:"TenantId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenant",children:"Tenant"})}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: Gets a Tenant from the LH Server."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putprincipal",children:["RPC ",(0,r.jsx)(s.code,{children:"PutPrincipal"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putprincipalrequest",children:"PutPrincipalRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principal",children:"Principal"})}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: Creates an Principal."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"whoami",children:["RPC ",(0,r.jsx)(s.code,{children:"Whoami"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principal",children:"Principal"})}),(0,r.jsx)(s.td,{children:"Returns the Principal of the caller."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getserverversion",children:["RPC ",(0,r.jsx)(s.code,{children:"GetServerVersion"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serverversionresponse",children:"ServerVersionResponse"})}),(0,r.jsx)(s.td,{children:"Gets the version of the LH Server."})]})})]}),"\n",(0,r.jsx)(s.h2,{id:"littlehorse-protobuf-schemas",children:"LittleHorse Protobuf Schemas"}),"\n",(0,r.jsx)(s.p,{children:"This section contains the exact schemas for every object in our public API."}),"\n",(0,r.jsxs)(s.h3,{id:"deleteprincipalrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeletePrincipalRequest"})]}),"\n",(0,r.jsxs)(s.p,{children:["Deletes a ",(0,r.jsx)(s.code,{children:"Principal"}),". Fails with ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"})," if the specified ",(0,r.jsx)(s.code,{children:"Principal"})," is the last\nadmin ",(0,r.jsx)(s.code,{children:"Principal"}),"."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principalid",children:"PrincipalId"})}),(0,r.jsxs)(s.td,{children:["The ID of the ",(0,r.jsx)(s.code,{children:"Principal"})," to delete."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"principal",children:["Message ",(0,r.jsx)(s.code,{children:"Principal"})]}),"\n",(0,r.jsx)(s.p,{children:"A Principal represents the identity of a client of LittleHorse, whether human or\nmachine. The ACL's on the Principal control what actions the client is allowed\nto take."}),"\n",(0,r.jsx)(s.p,{children:"A Principal is not scoped to a Tenant; rather, a Principal is scoped to the Cluster\nand may have access to one or more Tenants."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principalid",children:"PrincipalId"})}),(0,r.jsxs)(s.td,{children:["The ID of the Principal. In OAuth for human users, this is the user_id. In OAuth for machine clients, this is the Client ID.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"mTLS for Principal identification is not yet implemented."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time at which the Principal was created."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"per_tenant_acls"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principalpertenantaclsentry",children:"Principal.PerTenantAclsEntry"})}),(0,r.jsxs)(s.td,{children:["Maps a Tenant ID to a list of ACL's that the Principal has permission to execute ",(0,r.jsx)(s.em,{children:"within that Tenant"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"global_acls"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serveracls",children:"ServerACLs"})}),(0,r.jsxs)(s.td,{children:["Sets permissions that this Principal has ",(0,r.jsx)(s.em,{children:"for any Tenant"})," in the LH Cluster."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"principalpertenantaclsentry",children:["Message ",(0,r.jsx)(s.code,{children:"Principal.PerTenantAclsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serveracls",children:"ServerACLs"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putprincipalrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutPrincipalRequest"})]}),"\n",(0,r.jsxs)(s.p,{children:["Creates or updates a Principal. If this request would remove admin privileges from the\nlast admin principal (i.e. ",(0,r.jsx)(s.code,{children:"ALL_ACTIONS"})," over ",(0,r.jsx)(s.code,{children:"ACL_ALL_RESOURCES"})," in the ",(0,r.jsx)(s.code,{children:"global_acls"}),"),\nthen the RPC throws ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"}),"."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The ID of the Principal that we are creating."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"per_tenant_acls"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putprincipalrequestpertenantaclsentry",children:"PutPrincipalRequest.PerTenantAclsEntry"})}),(0,r.jsx)(s.td,{children:"The per-tenant ACL's for the Principal"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"global_acls"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serveracls",children:"ServerACLs"})}),(0,r.jsx)(s.td,{children:"The ACL's for the principal in all tenants"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"overwrite"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsxs)(s.td,{children:["If this is set to false and a ",(0,r.jsx)(s.code,{children:"Principal"})," with the same ",(0,r.jsx)(s.code,{children:"id"})," already exists ",(0,r.jsx)(s.em,{children:"and"})," has different ACL's configured, then the RPC throws ",(0,r.jsx)(s.code,{children:"ALREADY_EXISTS"}),".",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If this is set to ",(0,r.jsx)(s.code,{children:"true"}),", then the RPC will override hte"]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putprincipalrequestpertenantaclsentry",children:["Message ",(0,r.jsx)(s.code,{children:"PutPrincipalRequest.PerTenantAclsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serveracls",children:"ServerACLs"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"puttenantrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutTenantRequest"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"serveracl",children:["Message ",(0,r.jsx)(s.code,{children:"ServerACL"})]}),"\n",(0,r.jsxs)(s.p,{children:["Represents a specific set of permissions over a specific set of objects\nin a Tenant. This is a ",(0,r.jsx)(s.em,{children:"positive"})," permission."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"resources"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#aclresource",children:"ACLResource"})}),(0,r.jsx)(s.td,{children:"The resource types over which permission is granted."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"allowed_actions"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#aclaction",children:"ACLAction"})}),(0,r.jsx)(s.td,{children:"The actions that are permitted."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"resource_filter"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["If set, then only the resources with this exact name are allowed. For example, the ",(0,r.jsx)(s.code,{children:"READ"})," and ",(0,r.jsx)(s.code,{children:"RUN"})," ",(0,r.jsx)(s.code,{children:"allowed_actions"})," over ",(0,r.jsx)(s.code,{children:"ACL_TASK"})," with ",(0,r.jsx)(s.code,{children:"name"})," == ",(0,r.jsx)(s.code,{children:"my-task"})," allows a Task Worker to only execute the ",(0,r.jsx)(s.code,{children:"my-task"})," TaskDef.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If ",(0,r.jsx)(s.code,{children:"name"})," and ",(0,r.jsx)(s.code,{children:"prefix"})," are unset, then the ACL applies to all resources of the specified types."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"resource_filter"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["If set, then only the resources whose names match this prefix are allowed.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If ",(0,r.jsx)(s.code,{children:"name"})," and ",(0,r.jsx)(s.code,{children:"prefix"})," are unset, then the ACL applies to all resources of the specified types."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"serveracls",children:["Message ",(0,r.jsx)(s.code,{children:"ServerACLs"})]}),"\n",(0,r.jsx)(s.p,{children:"List of ACL's for LittleHorse"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"acls"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serveracl",children:"ServerACL"})}),(0,r.jsx)(s.td,{children:"The associated ACL's"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"tenant",children:["Message ",(0,r.jsx)(s.code,{children:"Tenant"})]}),"\n",(0,r.jsx)(s.p,{children:"A Tenant is a logically isolated environment within LittleHorse. All workflows and\nassociated data (WfSpec, WfRun, TaskDef, TaskRun, NodeRun, etc) are scoped to within\na Tenant."}),"\n",(0,r.jsx)(s.p,{children:"Future versions will include quotas on a per-Tenant basis."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenantid",children:"TenantId"})}),(0,r.jsx)(s.td,{children:"The ID of the Tenant."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time at which the Tenant was created."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"exponentialbackoffretrypolicy",children:["Message ",(0,r.jsx)(s.code,{children:"ExponentialBackoffRetryPolicy"})]}),"\n",(0,r.jsxs)(s.p,{children:["Defines an Exponential backoff policy for TaskRun retries. The delay for a retry\nattempt ",(0,r.jsx)(s.code,{children:"N"})," is defined as:"]}),"\n",(0,r.jsx)(s.p,{children:"min(base_interval_ms * (multiplier ^(N-1)), max_delay_ms)"}),"\n",(0,r.jsx)(s.p,{children:"Note that timers in LittleHorse have a resolution of about 500-1000 milliseconds,\nso timing is not exact."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"base_interval_ms"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Base delay in ms for the first retry. Note that in LittleHorse, timers have a resolution of 500-1000 milliseconds. Must be greater than zero."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"max_delay_ms"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Maximum delay in milliseconds between retries."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"multiplier"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"float"}),(0,r.jsx)(s.td,{children:"The multiplier to use in calculating the retry backoff policy. We recommend starting with 2.0. Must be at least 1.0."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"tasknode",children:["Message ",(0,r.jsx)(s.code,{children:"TaskNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines a TaskRun execution. Used in a Node and also in the UserTask Trigger Actions."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"task_to_execute"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"dynamic_task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"task_to_execute"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"timeout_seconds"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"How long until LittleHorse determines that the Task Worker had a technical ERROR if the worker does not yet reply to the Server. This is determined on a per-Attempt basis."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retries"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["Configures the amount of retries allowed on this TaskNode.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Retryable errors include: - TASK_TIMEOUT: the TaskRun was started but the scheduler didn't hear back from the Task Worker in time. - TASK_FAILED: the Task Worker reported an unexpected ",(0,r.jsx)(s.em,{children:"technical"})," ERROR when executing the Task Function.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Other result codes are not retryable (including TASK_OUTPUT_SERIALIZING_ERROR, TASK_INPUT_VAR_SUB_ERROR, and TASK_EXCEPTION)."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exponential_backoff"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#exponentialbackoffretrypolicy",children:"ExponentialBackoffRetryPolicy"})}),(0,r.jsx)(s.td,{children:"If this field is set, then retries will use Exponential Backoff."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Input variables into the TaskDef."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"utactiontrigger",children:["Message ",(0,r.jsx)(s.code,{children:"UTActionTrigger"})]}),"\n",(0,r.jsx)(s.p,{children:"A UTActionTrigger triggers an action upon certain lifecycle hooks\nin a User Task. Actions include:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"re-assign the User Task Run"}),"\n",(0,r.jsx)(s.li,{children:"cancel the User Task Run"}),"\n",(0,r.jsx)(s.li,{children:"execute a Reminder Task"}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Hooks include:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"Upon creation of the UserTaskRun"}),"\n",(0,r.jsx)(s.li,{children:"Upon rescheduling the UserTaskRun"}),"\n"]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"action"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#utactiontriggerutatask",children:"UTActionTrigger.UTATask"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"cancel"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"action"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#utactiontriggerutacancel",children:"UTActionTrigger.UTACancel"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"reassign"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"action"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#utactiontriggerutareassign",children:"UTActionTrigger.UTAReassign"})}),(0,r.jsx)(s.td,{children:"later on, might enable scheduling entire ThreadRuns"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"delay_seconds"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"The Action is triggered some time after the Hook matures. The delay is controlled by this field."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"hook"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#utactiontriggeruthook",children:"UTActionTrigger.UTHook"})}),(0,r.jsx)(s.td,{children:"The hook on which this UserTaskAction is scheduled."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"utactiontriggerutacancel",children:["Message ",(0,r.jsx)(s.code,{children:"UTActionTrigger.UTACancel"})]}),"\n",(0,r.jsx)(s.p,{children:"A UserTaskAction that causes a UserTaskRun to be CANCELLED when it fires."}),"\n",(0,r.jsxs)(s.h3,{id:"utactiontriggerutareassign",children:["Message ",(0,r.jsx)(s.code,{children:"UTActionTrigger.UTAReassign"})]}),"\n",(0,r.jsx)(s.p,{children:"A UserTaskAction that causes a UserTaskRun to be reassigned when it fires."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"A variable assignment that resolves to a STR representing the new user_id. If not set, the user_id of the UserTaskRun will be un-set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"A variable assignment that resolves to a STR representing the new user_group. If not set, the user_group of the UserTaskRun will be un-set."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"utactiontriggerutatask",children:["Message ",(0,r.jsx)(s.code,{children:"UTActionTrigger.UTATask"})]}),"\n",(0,r.jsx)(s.p,{children:"A UserTaskAction that causes a TaskRun to be scheduled when it fires."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tasknode",children:"TaskNode"})}),(0,r.jsx)(s.td,{children:"The specification of the Task to schedule."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"mutations"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablemutation",children:"VariableMutation"})}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: Any variables in the ThreadRun which we should mutate."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variableassignment",children:["Message ",(0,r.jsx)(s.code,{children:"VariableAssignment"})]}),"\n",(0,r.jsx)(s.p,{children:"A VariableAssignment is used within a WfSpec to determine how a value should be\nassigned in the context of a specific WfRun. For example, in a TASK node, you\nuse a VariableAssignment for each input parameter to determine how the value\nis set."}),"\n",(0,r.jsx)(s.p,{children:"Note that the VariableAssignment is normally handled by the SDK; you shouldn't\nhave to worry about this in daily LittleHorse usage."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"json_path"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["If you provide a ",(0,r.jsx)(s.code,{children:"variable_name"})," and the specified variable is JSON_OBJ or JSON_ARR type, then you may also provide a json_path which makes the VariableAssignment resolve to the specified field."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variable_name"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"source"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Assign the value from a variable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"literal_value"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"source"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Assign a literal value"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"format_string"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"source"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignmentformatstring",children:"VariableAssignment.FormatString"})}),(0,r.jsx)(s.td,{children:"Assign a format string"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variableassignmentformatstring",children:["Message ",(0,r.jsx)(s.code,{children:"VariableAssignment.FormatString"})]}),"\n",(0,r.jsx)(s.p,{children:"A FormatString formats a template String with values from the WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"format"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsxs)(s.td,{children:['A VariableAssignment which must resolve to a String that has format args. A valid string is "This is a format string with three args: ',0,", ",1,", ",2,'"']})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"args"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"VariableAssignments which fill out the args."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variabledef",children:["Message ",(0,r.jsx)(s.code,{children:"VariableDef"})]}),"\n",(0,r.jsx)(s.p,{children:"Declares a Variable."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabletype",children:"VariableType"})}),(0,r.jsx)(s.td,{children:"The Type of the variable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the variable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"default_value"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Optional default value if the variable isn't set; for example, in a ThreadRun if you start a ThreadRun or WfRun without passing a variable in, then this is used."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"masked_value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"If true, the variable value will show as a masked string."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variablemutation",children:["Message ",(0,r.jsx)(s.code,{children:"VariableMutation"})]}),"\n",(0,r.jsx)(s.p,{children:"A VariableMutation defines a modification made to one of a ThreadRun's variables.\nThe LHS determines the variable that is modified; the operation determines how\nit is modified, and the RHS is the input to the operation."}),"\n",(0,r.jsx)(s.p,{children:"Day-to-day users of LittleHorse generally don't interact with this structure unless\nthey are writing their own WfSpec SDK."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"lhs_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the variable to mutate"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"lhs_json_path"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate a specific sub-field of the variable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"operation"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablemutationtype",children:"VariableMutationType"})}),(0,r.jsx)(s.td,{children:"Defines the operation that we are executing."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"source_variable"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"rhs_value"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Set the source_variable as the RHS to use another variable from the workflow to as the RHS/"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"literal_value"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"rhs_value"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Use a literal value as the RHS."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_output"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"rhs_value"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablemutationnodeoutputsource",children:"VariableMutation.NodeOutputSource"})}),(0,r.jsx)(s.td,{children:"Use the output of the current node as the RHS."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variablemutationnodeoutputsource",children:["Message ",(0,r.jsx)(s.code,{children:"VariableMutation.NodeOutputSource"})]}),"\n",(0,r.jsx)(s.p,{children:"Specifies to use the output of a NodeRun as the RHS."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"jsonpath"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Use this specific field from a JSON output"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"externalevent",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEvent"})]}),"\n",(0,r.jsx)(s.p,{children:"An ExternalEvent represents A Thing That Happened outside the context of a WfRun.\nGenerally, an ExternalEvent is used to represent a document getting signed, an incident\nbeing resolved, an order being fulfilled, etc."}),"\n",(0,r.jsx)(s.p,{children:"ExternalEvent's are created via the 'rpc PutExternalEvent'"}),"\n",(0,r.jsxs)(s.p,{children:["For more context on ExternalEvents, check our documentation here:\n",(0,r.jsx)(s.a,{href:"https://littlehorse.dev/docs/concepts/external-events",children:"https://littlehorse.dev/docs/concepts/external-events"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsxs)(s.td,{children:["The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId, and a unique guid which can be used for idempotency of the ",(0,r.jsx)(s.code,{children:"PutExternalEvent"})," rpc call."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the ExternalEvent was registered with LittleHorse."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The payload of this ExternalEvent."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_position"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT Node; note that in the case of an Interrupt the node_run_position will never be set), this is set to the number of the relevant NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"claimed"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether the ExternalEvent has been claimed by a WfRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventdef",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventDef"})]}),"\n",(0,r.jsx)(s.p,{children:"The ExternalEventDef defines the blueprint for an ExternalEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The id of the ExternalEventDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"When the ExternalEventDef was created."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retention_policy"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventretentionpolicy",children:"ExternalEventRetentionPolicy"})}),(0,r.jsxs)(s.td,{children:["The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the ExternalEvent ",(0,r.jsx)(s.strong,{children:"only before"})," it is matched with a WfRun."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventretentionpolicy",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventRetentionPolicy"})]}),"\n",(0,r.jsx)(s.p,{children:"Policy to determine how long an ExternalEvent is retained after creation if it\nis not yet claimed by a WfRun. Note that once a WfRun has been matched with the\nExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.\nIf not set, then ExternalEvent's are not deleted if they are not matched with\na WfRun."}),"\n",(0,r.jsxs)(s.p,{children:["A future version of LittleHorse will allow changing the retention_policy, which\nwill trigger a cleanup of old ",(0,r.jsx)(s.code,{children:"ExternalEvent"}),"s."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"seconds_after_put"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"ext_evt_gc_policy"})]}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Delete such an ExternalEvent X seconds after it has been registered if it has not yet been claimed by a WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"entrypointrun",children:["Message ",(0,r.jsx)(s.code,{children:"EntrypointRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for an ENTRYPOINT NodeRun. Currently Empty."}),"\n",(0,r.jsxs)(s.h3,{id:"exitrun",children:["Message ",(0,r.jsx)(s.code,{children:"ExitRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for an EXIT NodeRun. Currently Empty, will contain info\nabout ThreadRun Outputs once those are added in the future."}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventnoderun",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventNodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for an EXTERNAL_EVENT NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ExternalEventDefId that we are waiting for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"event_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time that the ExternalEvent arrived. Unset if still waiting."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"The ExternalEventId of the ExternalEvent. Unset if still waiting."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"timed_out"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether we had a timeout while waiting for the ExternalEvent to come."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"failure",children:["Message ",(0,r.jsx)(s.code,{children:"Failure"})]}),"\n",(0,r.jsx)(s.p,{children:"Denotes a failure that happened during execution of a NodeRun or the outgoing\nedges."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["The name of the failure. LittleHorse has certain built-in failures, all named in UPPER_UNDERSCORE_CASE. Such failures correspond with the ",(0,r.jsx)(s.code,{children:"LHStatus.ERROR"}),".",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Any Failure named in ",(0,r.jsx)(s.code,{children:"kebab-case"})," is a user-defined business ",(0,r.jsx)(s.code,{children:"EXCEPTION"}),", treated as an ",(0,r.jsx)(s.code,{children:"LHStatus.EXCEPTION"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"message"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The human-readable message associated with this Failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsxs)(s.td,{children:["A user-defined Failure can have a value; for example, in Java an Exception is an Object with arbitrary properties and behaviors.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Future versions of LH will allow FailureHandler threads to accept that value as an input variable."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"was_properly_handled"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"A boolean denoting whether a Failure Handler ThreadRun properly handled the Failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_handler_threadrun_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"If there is a defined failure handler for the NodeRun, then this field is set to the id of the failure handler thread run."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"noderun",children:["Message ",(0,r.jsx)(s.code,{children:"NodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"A NodeRun is a running instance of a Node in a ThreadRun. Note that a NodeRun\nis a Getable object, meaning it can be retried from the LittleHorse grpc API."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the ThreadRun's number, and the position of the NodeRun within that ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsxs)(s.td,{children:["The ID of the WfSpec that this NodeRun is from. This is not ",(0,r.jsx)(s.em,{children:"always"})," the same as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration feature."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_handler_ids"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"The status of this NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"arrival_time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the ThreadRun arrived at this NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"end_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the NodeRun was terminated (failed or completed)."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to which this NodeRun belongs."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the Node in the ThreadSpec that this NodeRun belongs to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"error_message"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"A human-readable error message intended to help developers diagnose WfSpec problems."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failures"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failure",children:"Failure"})}),(0,r.jsx)(s.td,{children:"A list of Failures thrown by this NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tasknoderun",children:"TaskNodeRun"})}),(0,r.jsx)(s.td,{children:"Denotes a TASK node, which runs a TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventnoderun",children:"ExternalEventNodeRun"})}),(0,r.jsx)(s.td,{children:"An EXTERNAL_EVENT node blocks until an ExternalEvent arrives."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"entrypoint"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#entrypointrun",children:"EntrypointRun"})}),(0,r.jsx)(s.td,{children:"An ENTRYPOINT node is the first thing that runs in a ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exit"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#exitrun",children:"ExitRun"})}),(0,r.jsx)(s.td,{children:"An EXIT node completes a ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_thread"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startthreadrun",children:"StartThreadRun"})}),(0,r.jsx)(s.td,{children:"A START_THREAD node starts a child ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wait_threads"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsrun",children:"WaitForThreadsRun"})}),(0,r.jsx)(s.td,{children:"A WAIT_THREADS node waits for one or more child ThreadRun's to complete."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"sleep"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#sleepnoderun",children:"SleepNodeRun"})}),(0,r.jsx)(s.td,{children:"A SLEEP node makes the ThreadRun block for a certain amount of time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertasknoderun",children:"UserTaskNodeRun"})}),(0,r.jsx)(s.td,{children:"A USER_TASK node waits until a human executes some work and reports the result."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_multiple_threads"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startmultiplethreadsrun",children:"StartMultipleThreadsRun"})}),(0,r.jsx)(s.td,{children:"A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a child ThreadRun for each element in the list."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"throw_event"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#throweventnoderun",children:"ThrowEventNodeRun"})}),(0,r.jsx)(s.td,{children:"A THROW_EVENT node throws a WorkflowEvent of a specified WorkflowEventDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wait_for_condition"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforconditionrun",children:"WaitForConditionRun"})}),(0,r.jsx)(s.td,{children:"A WAIT_FOR_CONDITION node blocks the ThreadRun until the specified condition evaluates to True."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"sleepnoderun",children:["Message ",(0,r.jsx)(s.code,{children:"SleepNodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a SLEEP NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"maturation_time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["The time at which the NodeRun is ",(0,r.jsx)(s.em,{children:"SCHEDULED TO"}),' wake up. In rare cases, if the LH Server is back-pressuring clients due to extreme load, the timer event which marks the sleep node as "matured" may come in slightly late.']})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"matured"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether the SleepNodeRun has been matured."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startmultiplethreadsrun",children:["Message ",(0,r.jsx)(s.code,{children:"StartMultipleThreadsRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a START_MULTIPLE_THREADS NodeRun."}),"\n",(0,r.jsx)(s.p,{children:"Note: the output of this NodeRun, which can be used to mutate Variables,\nis a JSON_ARR variable containing the ID's of all the child threadRuns."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The thread_spec_name of the child thread_runs."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"child_thread_ids"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The list of all created child ThreadRun's"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startthreadrun",children:["Message ",(0,r.jsx)(s.code,{children:"StartThreadRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a START_THREAD NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"child_thread_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Contains the thread_run_number of the created Child ThreadRun, if it has been created already."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The thread_spec_name of the child thread_run."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"tasknoderun",children:["Message ",(0,r.jsx)(s.code,{children:"TaskNodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a TASK NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived at this TASK Node, then the task_run_id will be unset."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"throweventnoderun",children:["Message ",(0,r.jsx)(s.code,{children:"ThrowEventNodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a THROW_EVENT NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"workflow_event_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventid",children:"WorkflowEventId"})}),(0,r.jsxs)(s.td,{children:["The ID of the ",(0,r.jsx)(s.code,{children:"WorkflowEvent"})," that was thrown by this ",(0,r.jsx)(s.code,{children:"ThrowEventNodeRun"}),"."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertasknoderun",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskNodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a USER_TASK NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived at this USER_TASK node, then the user_task_run_id will be unset."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforconditionrun",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForConditionRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a WAIT_FOR_CONDITION NodeRun"}),"\n",(0,r.jsxs)(s.h3,{id:"waitforthreadsrun",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForThreadsRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a WAIT_FOR_THREADS NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"threads"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsrunwaitforthread",children:"WaitForThreadsRun.WaitForThread"})}),(0,r.jsx)(s.td,{children:"The threads that are being waited for."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforthreadsrunwaitforthread",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForThreadsRun.WaitForThread"})]}),"\n",(0,r.jsx)(s.p,{children:"A 'WaitForThread' structure defines a thread that is being waited for."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_end_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun is still RUNNING, HALTED, or HALTING."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"The current status of the ThreadRun being waited for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The number of the ThreadRun being waited for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"waiting_status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsrunwaitingthreadstatus",children:"WaitForThreadsRun.WaitingThreadStatus"})}),(0,r.jsx)(s.td,{children:'The "waiting status" of this specific thread: whether it\'s still running, already done, handling a failure, or completely failed.'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_handler_thread_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"If there is a failure on the ThreadRun, and we have a failure handler defined for it, then we will start a failure handler for this threadrun. This field is the id of that threadRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventdefid",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventDefId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for ExternalEventDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"ExternalEventDef's are uniquedly identified by their name."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventid",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for an ExternalEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"WfRunId for the ExternalEvent. Note that every ExternalEvent is associated with a WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ExternalEventDef for this ExternalEvent."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"guid"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"A unique guid allowing for distinguishing this ExternalEvent from other events of the same ExternalEventDef and WfRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"noderunid",children:["Message ",(0,r.jsx)(s.code,{children:"NodeRunId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"ID of the WfRun for this NodeRun. Note that every NodeRun is associated with a WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"ThreadRun of this NodeRun. Note that each NodeRun belongs to a ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"position"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Position of this NodeRun within its ThreadRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"principalid",children:["Message ",(0,r.jsx)(s.code,{children:"PrincipalId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a Principal."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The id of this principal. In OAuth, this is the OAuth Client ID (for machine principals) or the OAuth User Id (for human principals)."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"scheduledwfrunid",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduledWfRunId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a ScheduledWfRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefid",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a TaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"TaskDef's are uniquely identified by their name."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefmetricsid",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefMetricsId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a specific window of TaskDef metrics."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The timestamp at which this metrics window starts."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The length of this window."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The TaskDefId that this metrics window reports on."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskrunid",children:["Message ",(0,r.jsx)(s.code,{children:"TaskRunId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a TaskRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"WfRunId for this TaskRun. Note that every TaskRun is associated with a WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_guid"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Unique identifier for this TaskRun. Unique among the WfRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskworkergroupid",children:["Message ",(0,r.jsx)(s.code,{children:"TaskWorkerGroupId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a TaskWorkerGroup."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"TaskWorkerGroups are uniquely identified by their TaskDefId."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"tenantid",children:["Message ",(0,r.jsx)(s.code,{children:"TenantId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a Tenant."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The Tenant ID."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskdefid",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskDefId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a UserTaskDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of a UserTaskDef"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Note that UserTaskDef's use simple versioning."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskrunid",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskRunId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a UserTaskRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"WfRunId for this UserTaskRun. Note that every UserTaskRun is associated with a WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_guid"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Unique identifier for this UserTaskRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variableid",children:["Message ",(0,r.jsx)(s.code,{children:"VariableId"})]}),"\n",(0,r.jsx)(s.p,{children:"Id for a Variable."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"WfRunId for the variable. Note that every Variable is associated with a WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Each Variable is owned by a specific ThreadRun inside the WfRun it belongs to. This is that ThreadRun's number."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the variable."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfrunid",children:["Message ",(0,r.jsx)(s.code,{children:"WfRunId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a WfRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The ID for this WfRun instance."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"A WfRun may have a parent WfRun. If so, this field is set to the parent's ID."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecid",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecId"})]}),"\n",(0,r.jsx)(s.p,{children:"The ID of a WfSpec."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Name of the WfSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["Major Version of a WfSpec.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Note that WfSpec's are versioned. Creating a new WfSpec with the same name and no breaking changes to the public Variables API results in a new WfSpec being created with the same MajorVersion and a new revision. Creating a WfSpec with a breaking change to the public Variables API results in a new WfSpec being created with the same name, an incremented major_version, and revision = 0."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"revision"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["Revision of a WfSpec.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Note that WfSpec's are versioned. Creating a new WfSpec with the same name and no breaking changes to the public Variables API results in a new WfSpec being created with the same MajorVersion and a new revision. Creating a WfSpec with a breaking change to the public Variables API results in a new WfSpec being created with the same name, an incremented major_version, and revision = 0."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecmetricsid",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecMetricsId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a specific window of WfSpec metrics."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The timestamp at which this metrics window starts."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The length of this window."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The WfSpecId that this metrics window reports on."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"workfloweventdefid",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEventDefId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a WorkflowEventDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the WorkflowEventDef"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"workfloweventid",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEventId"})]}),"\n",(0,r.jsx)(s.p,{children:"An ID for a WorkflowEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The Id of the WfRun that threw the event."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"workflow_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the WorkflowEventDef that this WorkflowEvent is a member of."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"A sequence number that makes the WorkflowEventId unique among all WorkflowEvent's of the same type thrown by the WfRun. This field starts at zero and is incremented every time a WorkflowEvent of the same type is thrown by the same WfRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"scheduledwfrun",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduledWfRun"})]}),"\n",(0,r.jsxs)(s.p,{children:["A ",(0,r.jsx)(s.code,{children:"ScheduledWfRun"})," is an object in the LittleHorse API that triggers a ",(0,r.jsx)(s.code,{children:"WfRun"})," to be started\non a cron schedule."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunid",children:"ScheduledWfRunId"})}),(0,r.jsx)(s.td,{children:"Unique id for this ScheduledWfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"WfSpec used to run a workflow on a schedule."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunvariablesentry",children:"ScheduledWfRun.VariablesEntry"})}),(0,r.jsx)(s.td,{children:"A map from Variable Name to Values for those variables. The provided variables are passed as input to the Entrypoint ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"Parent WfRunId associated with all the generated WfRuns"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"cron_expression"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"UNIX expression used to specify the schedule for executing WfRuns"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Creation time for this ScheduledWfRun"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"scheduledwfrunvariablesentry",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduledWfRun.VariablesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"awaitworkfloweventrequest",children:["Message ",(0,r.jsx)(s.code,{children:"AwaitWorkflowEventRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Request to await until a WorkflowEvent of a certain WorkflowEventDef on a certain WfRun\nis thrown. Relies upon native GRPC deadlines to configure timeouts."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfRun which must throw the WorkflowEvent."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"event_def_ids"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{children:"The IDs of the WorkflowEventDef that must be thrown. The request will return the first matching WorkflowEvent is thrown. If event_def_ids is empty, then the request will return the first WorkflowEvent thrown by the WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"workflow_events_to_ignore"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventid",children:"WorkflowEventId"})}),(0,r.jsx)(s.td,{children:"Since a single WfRun may throw multiple WorkflowEvent's with the same WorkflowEventDefId, it is necessary to provide a client the ability to \"ignore\" WorkflowEvent's that have already been 'awaited'. Any WorkflowEvent specified by this field is ignored by the rpc."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteexternaleventdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteExternalEventDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes an ExternalEventDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEventDef to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteexternaleventrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteExternalEventRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes an ExternalEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEvent to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletescheduledwfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteScheduledWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Delete an existing ScheduledWfRun, returns INVALID_ARGUMENT if object does not exist"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunid",children:"ScheduledWfRunId"})}),(0,r.jsxs)(s.td,{children:["Id of the ",(0,r.jsx)(s.code,{children:"ScheduledWfRun"})," to be deleted"]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletetaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes a TaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the TaskDef to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteusertaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteUserTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes a UserTaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdefid",children:"UserTaskDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the UserTaskDef to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletewfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfRun to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletewfspecrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteWfSpecRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes a WfSpec"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfSpec to delete"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventdefidlist",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventDefIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of ExternalEventDef Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventidlist",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of ExternalEvent Id's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventlist",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of ExternalEvents."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externalevent",children:"ExternalEvent"})}),(0,r.jsx)(s.td,{children:"A list of ExternalEvent objects."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getlatestusertaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"GetLatestUserTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Returns the UserTaskDef with a given name and the highest version number."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the UserTaskDef to search for."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getlatestwfspecrequest",children:["Message ",(0,r.jsx)(s.code,{children:"GetLatestWfSpecRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Get the latest WfSpec with a given name and optionally majorVersion"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the WfSpec to get. This is required."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally get only WfSpec's that have the same major version. This can be useful if you want to guarantee that there have been no breaking changes to the API of the WfSpec, for example, to ensure that there have been no changes to searchable variables or required input variables."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"lhhostinfo",children:["Message ",(0,r.jsx)(s.code,{children:"LHHostInfo"})]}),"\n",(0,r.jsx)(s.p,{children:"Information about a specific LH Server to contact."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"host"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The host on the server"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"port"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The port for the specified listener."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"listexternaleventsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListExternalEventsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List all ExternalEvents for a specific WfRunId. Note that List Requests return actual\nExternalEvent objects, not ExternalEventId's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRunId for whom we list ExternalEvent's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listnoderunsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListNodeRunsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List all NodeRun's for a given WfRun. Note that List requests return actual NodeRun Objects,\nnot NodeRunId's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRun for whom we list NodeRun's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally specify the thread run number to filter NodeRun's by."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"listtaskmetricsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListTaskMetricsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Query to retrieve TaskDef Metrics over a period of time."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"TaskDef id for whichwe retrieve metrics."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"last_window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["This parameter is a timestamp that is used to determine the ",(0,r.jsx)(s.em,{children:"last"})," window returned. The server will then return ",(0,r.jsx)(s.code,{children:"num_windows"})," worth of data from before this timestamp."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_length"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"Window size"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"num_windows"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Number of windows to retrieve."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"listtaskmetricsresponse",children:["Message ",(0,r.jsx)(s.code,{children:"ListTaskMetricsResponse"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of TaskDef Metrics WIndows"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefmetrics",children:"TaskDefMetrics"})}),(0,r.jsx)(s.td,{children:"List of TaskDef Metrics Windows"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listtaskrunsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListTaskRunsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List TaskRun's for a specific WfRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRun for which to list TaskRun's"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listusertaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListUserTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List UserTaskRun's for a specific WfRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRun for which to list UserTaskRuns"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listvariablesrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListVariablesRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List all Variables for a specific WfRun. Note that List requests return actual Variable Objects,\nnot VariableId's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRun for whom we will list Variables."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listwfmetricsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListWfMetricsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Query to retrieve WfSpec Metrics over a period of time."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"WfSpecId of metrics to get."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"last_window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["This parameter is a timestamp that is used to determine the ",(0,r.jsx)(s.em,{children:"last"})," window returned. The server will then return ",(0,r.jsx)(s.code,{children:"num_windows"})," worth of data from before this timestamp."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_length"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The window size"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"num_windows"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Number of windows to retrieve"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"listwfmetricsresponse",children:["Message ",(0,r.jsx)(s.code,{children:"ListWfMetricsResponse"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of WfSpec Metrics Windows"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecmetrics",children:"WfSpecMetrics"})}),(0,r.jsx)(s.td,{children:"List of WfSpec Metrics Windows"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"migratewfspecrequest",children:["Message ",(0,r.jsx)(s.code,{children:"MigrateWfSpecRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"EXPERIMENTAL: migrate live WfRun's from one version of a WfSpec to another."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"old_wf_spec"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"migration"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecversionmigration",children:"WfSpecVersionMigration"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"noderunidlist",children:["Message ",(0,r.jsx)(s.code,{children:"NodeRunIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of NodeRun Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"noderunlist",children:["Message ",(0,r.jsx)(s.code,{children:"NodeRunList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of NodeRun Objects."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderun",children:"NodeRun"})}),(0,r.jsx)(s.td,{children:"A list of NodeRun Objects."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"polltaskrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PollTaskRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Request sent by the Task Worker SDK to tell the Server that the Task Worker is ready\nto execute a TaskRun. Generally used only by the Task Worker SDK."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"Is the TaskDefId that the Task Worker wants to execute."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"client_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Is the ID of the Task Worker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_worker_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optionally specifies the version of the Task Worker, so that it can be recorded for debugging purposes on the TaskRun itself."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"polltaskresponse",children:["Message ",(0,r.jsx)(s.code,{children:"PollTaskResponse"})]}),"\n",(0,r.jsx)(s.p,{children:"Response from the server for PollTaskRequest."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"result"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledtask",children:"ScheduledTask"})}),(0,r.jsx)(s.td,{children:"If possible, a ScheduledTask is returned."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"principalidlist",children:["Message ",(0,r.jsx)(s.code,{children:"PrincipalIdList"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principalid",children:"PrincipalId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putexternaleventdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutExternalEventDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Field to create an ExternalEventDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the resulting ExternalEventDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retention_policy"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventretentionpolicy",children:"ExternalEventRetentionPolicy"})}),(0,r.jsxs)(s.td,{children:["Policy to determine how long an ExternalEvent is retained after creation if it is not yet claimed by a WfRun. Note that once a WfRun has been matched with the ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted. If not set, then ExternalEvent's are not deleted if they are not matched with a WfRun.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"A future version of LittleHorse will allow changing the retention_policy, which will trigger a cleanup of old ",(0,r.jsx)(s.code,{children:"ExternalEvent"}),"s."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putexternaleventrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutExternalEventRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Request used to create an ExternalEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfRun that this Event is sent to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEventDef that this event implements."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"guid"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Note that an ExternalEventDefId is a three-part ID: 1. WfRunId 2. ExternalEventDef Name 3. A guid The guid from part 3) can be optionally provided to the PutExternalEventRequest in order to make it idempotent. It is a best practice to do so."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The content of this event."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally specify that this ExternalEvent may only be claimed by a specific ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_position"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally specify that this ExternalEvent may only be claimed by a specific NodeRun. In order for this to be set, you must also set thread_run_number."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"puttaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Creates a TaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the TaskDef to create."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"input_vars"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabledef",children:"VariableDef"})}),(0,r.jsx)(s.td,{children:"Variables required to execute the TaskDef. Normally, these are automatically generated by the Task Worker SDK."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"output_schema"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefoutputschema",children:"TaskDefOutputSchema"})}),(0,r.jsx)(s.td,{children:"Schema that validates the TaskDef's output"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putusertaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutUserTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Creates a UserTaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the UserTaskDef to create."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"fields"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskfield",children:"UserTaskField"})}),(0,r.jsx)(s.td,{children:"The fields that should be presented to the user on the screen in order to fill out the User Task. Note that these fields also define a data contract for the result of the UserTaskDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"description"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optional metadata field to store user-defined data. Does not impact workflow execution. Fine to store up to a few KB of text here."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putwfspecrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutWfSpecRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Creates a WfSpec. Generally, this request is generated by the Workflow object in\nour various SDK's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the resulting WfSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_specs"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putwfspecrequestthreadspecsentry",children:"PutWfSpecRequest.ThreadSpecsEntry"})}),(0,r.jsx)(s.td,{children:"Map from name the ThreadSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"entrypoint_thread_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to be used as the workflow entrypoint."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retention_policy"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workflowretentionpolicy",children:"WorkflowRetentionPolicy"})}),(0,r.jsx)(s.td,{children:"Optional policy to determine how long a WfRun is retained in the data store after it is completed or terminated."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_spec"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecparentwfspecreference",children:"WfSpec.ParentWfSpecReference"})}),(0,r.jsxs)(s.td,{children:["Parent WfSpec Reference. If this is set, then all WfRun's for this WfSpec ",(0,r.jsx)(s.em,{children:"MUST"})," be Child WfRun's of the specified WfSpec."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"allowed_updates"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#allowedupdatetype",children:"AllowedUpdateType"})}),(0,r.jsx)(s.td,{children:"Configures the behavior of this individual request. Can be used to prevent breaking changes to the WfSpec, prevent any changes to the WfSpec, or allow all changes to the WfSpec."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putwfspecrequestthreadspecsentry",children:["Message ",(0,r.jsx)(s.code,{children:"PutWfSpecRequest.ThreadSpecsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadspec",children:"ThreadSpec"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putworkfloweventdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutWorkflowEventDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"EXPERIMENTAL: Creates a WorkflowEventDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabletype",children:"VariableType"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"registertaskworkerrequest",children:["Message ",(0,r.jsx)(s.code,{children:"RegisterTaskWorkerRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Message used by Task Worker to register itself to the server and ask for assignments of\nservers to poll."}),"\n",(0,r.jsx)(s.p,{children:"Used by the Task Worker SDK; generally, you shouldn't have to touch this manually."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_worker_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Is the ID of the Task Worker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The TaskDef the worker wants to poll for."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"registertaskworkerresponse",children:["Message ",(0,r.jsx)(s.code,{children:"RegisterTaskWorkerResponse"})]}),"\n",(0,r.jsx)(s.p,{children:"Response containing list of Servers that the Task Worker should connect to and start polling from.\nOnly used internally by the Task Worker SDK."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"your_hosts"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhhostinfo",children:"LHHostInfo"})}),(0,r.jsx)(s.td,{children:"The list of LH Server hosts that the Task Worker should start polling."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"is_cluster_healthy"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether the LH Cluster is healthy."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"reporttaskrun",children:["Message ",(0,r.jsx)(s.code,{children:"ReportTaskRun"})]}),"\n",(0,r.jsx)(s.p,{children:"Request used by the Task Worker SDK to report the result of a TaskRun execution."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:"ID of the TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"When the TaskRun was executed"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskstatus",children:"TaskStatus"})}),(0,r.jsx)(s.td,{children:"Status of the TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"log_output"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Optional information for logging or exceptions"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"attempt_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Attempt number of the TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"output"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Successfully completed task"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"error"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhtaskerror",children:"LHTaskError"})}),(0,r.jsx)(s.td,{children:"Technical error"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exception"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhtaskexception",children:"LHTaskException"})}),(0,r.jsx)(s.td,{children:"Business exception"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"rescuethreadrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"RescueThreadRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"The request used to rescue a failed ThreadRun at a specific NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsxs)(s.td,{children:["The id of the ",(0,r.jsx)(s.code,{children:"WfRun"})," which we are going to rescue."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The number of the failed ",(0,r.jsx)(s.code,{children:"ThreadRun"})," that we will rescue. The specified ",(0,r.jsx)(s.code,{children:"ThreadRun"})," must be in a state where it's latest ",(0,r.jsx)(s.code,{children:"NodeRun"})," is: ",(0,r.jsx)("br",{})," - In the ",(0,r.jsx)(s.code,{children:"ERROR"})," state.",(0,r.jsx)("br",{})," - Has no ",(0,r.jsx)(s.code,{children:"FailureHandler"})," ",(0,r.jsx)(s.code,{children:"ThreadRun"}),"s ",(0,r.jsx)("br",{})," - The parent ",(0,r.jsx)(s.code,{children:"ThreadRun"}),", or any parent of the parent, has not handled the ",(0,r.jsx)(s.code,{children:"Failure"})," yet.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If that is not true, then the ",(0,r.jsx)(s.code,{children:"ThreadRun"})," cannot be rescued and the request will return ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"skip_current_node"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsxs)(s.td,{children:["If set to ",(0,r.jsx)(s.code,{children:"true"}),", then the ThreadRun will skip past the ",(0,r.jsx)(s.code,{children:"Node"})," of the current failed ",(0,r.jsx)(s.code,{children:"NodeRun"})," and advance according to the outgoing edges. If set to ",(0,r.jsx)(s.code,{children:"false"}),", then the ",(0,r.jsx)(s.code,{children:"ThreadRun"})," will schedule another ",(0,r.jsx)(s.code,{children:"NodeRun"})," for the current ",(0,r.jsx)(s.code,{children:"Node"})]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"resumewfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ResumeWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Resume a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"Is the WfRunId"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The number of the ThreadRun to resume. Note that resuming the entrypoint ThreadRun (which always has number ",(0,r.jsx)(s.code,{children:"0"}),") causes the whole WfRun to resume. If you do not manually set the thread_run_number field, it defaults to zero, so resuming the entire WfRun is the default behavior."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"runwfrequest",children:["Message ",(0,r.jsx)(s.code,{children:"RunWfRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Create a Workflow Run."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the WfSpec to run."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:'Optionally specify the major version of the WfSpec to run. This guarantees that the "signature" of the WfSpec (i.e. the required input variables, and searchable variables) will not change for this app.'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"revision"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally specify the specific revision of the WfSpec to run. It is not recommended to use this in practice, as the WfSpec logic should be de-coupled from the applications that run WfRun's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#runwfrequestvariablesentry",children:"RunWfRequest.VariablesEntry"})}),(0,r.jsx)(s.td,{children:"A map from Variable Name to Values for those variables. The provided variables are passed as input to the Entrypoint ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"You can optionally specify the ID of this WfRun. This is a recommended best practice as it also makes your request idempotent and allows you to easily find the WfRun at a later time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"runwfrequestvariablesentry",children:["Message ",(0,r.jsx)(s.code,{children:"RunWfRequest.VariablesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"schedulewfrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduleWfRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Schedule WfRuns based on a specific cron UNIX expression"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Specific ID"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the WfSpec to run."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:'Optionally specify the major version of the WfSpec to run. This guarantees that the "signature" of the WfSpec (i.e. the required input variables, and searchable variables) will not change for this app.'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"revision"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally specify the specific revision of the WfSpec to run. It is not recommended to use this in practice, as the WfSpec logic should be de-coupled from the applications that run WfRun's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#schedulewfrequestvariablesentry",children:"ScheduleWfRequest.VariablesEntry"})}),(0,r.jsx)(s.td,{children:"A map from Variable Name to Values for those variables. The provided variables are passed as input to the Entrypoint ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"Parent WfRunId associated with all the generated WfRuns"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"cron_expression"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"UNIX expression used to specify the schedule for executing WfRuns"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"schedulewfrequestvariablesentry",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduleWfRequest.VariablesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"scheduledtask",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduledTask"})]}),"\n",(0,r.jsx)(s.p,{children:"Message sent by server to Task Worker SDK specifying a specific TaskRun to be executed.\nThis is used and handled internally by the Task Worker SDK."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:"Id of the TaskRun to execute."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"ID of the TaskDef to which the TaskRun belongs."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"attempt_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["Attempt number of the TaskRun, zero indexed. attempt_number of ",(0,r.jsx)(s.code,{children:"0"})," means this is the first attempt; ",(0,r.jsx)(s.code,{children:"1"})," means this is the first retry, etc."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#varnameandval",children:"VarNameAndVal"})}),(0,r.jsx)(s.td,{children:"Input variables for this TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"source"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunsource",children:"TaskRunSource"})}),(0,r.jsx)(s.td,{children:"Source of the TaskRun. Currently, there are two options: 1. A TASK node 2. A reminder task scheduled by a trigger on a User Task."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"scheduledwfrunidlist",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduledWfRunIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of ScheduledWfRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunid",children:"ScheduledWfRunId"})}),(0,r.jsx)(s.td,{children:"A list of ScheduledWfRun Objects"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchexternaleventdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchExternalEventDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for ExternalEventDefs based on certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optionally search only for ExternalEventDef's whose name starts with this prefix."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchexternaleventrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchExternalEventRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for ExternalEvents based on certain criteria."}),"\n",(0,r.jsx)(s.p,{children:"Required field ExternalEventDefId specifies which ExternalEventDef\nto search for ExternalEvents under."}),"\n",(0,r.jsx)(s.p,{children:"At this time, it is not possible to make a search for all ExternalEvents."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only ExternalEvents created after this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only ExternalEvents created before this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsxs)(s.td,{children:["Search for ExternalEvents by their ExternalEventDefId",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"* Note: If ExternalEventDefId is not provided or does not exist, gRPC status code 'INVALID_ARGUMENT' will be returned."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"is_claimed"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Optionally search for only ExternalEvents that are claimed or not."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchnoderunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchNodeRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for NodeRun's by certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Only return NodeRun's created after this time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Only return NodeRun's created before this time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchnoderunrequestnodetype",children:"SearchNodeRunRequest.NodeType"})}),(0,r.jsx)(s.td,{children:"Specifies the type of NodeRun to search for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"Specifies the status of NodeRun to search for."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchprincipalrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchPrincipalRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for Principals based on certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only Principals's created after this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only Principals's created before this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"isAdmin"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"principal_criteria"})]}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"List only Principals that are admins"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"tenantId"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"principal_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"List Principals associated with this Tenant ID"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchscheduledwfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchScheduledWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search filters for ScheduledWfRun's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the WfSpec to filter"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The major version of the WfSpec to filter"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"revision"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The revision number of the WfSpec to filter"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for TaskDef's based on certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optionally specify to only return TaskDef's with a specific prefix."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Searches for TaskRuns by various criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Specifies the TaskDef of TaskRun's to return. This is required."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskstatus",children:"TaskStatus"})}),(0,r.jsx)(s.td,{children:"Specifies to only return TaskRun's matching this status."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to only return TaskRun's that were scheduled after this time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to only return TaskRun's that were scheduled before this time."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtenantrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchTenantRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for all available TenantIds for current Principal"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchusertaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchUserTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for UserTaskDef's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"user_task_def_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Return all UserTaskDef's with a specific prefix."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"user_task_def_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Return all UserTaskDef's with a specific name."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchusertaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchUserTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for UserTaskRun's matching certain criteria. The attributes are additive,\nyou may specify any combination of fields in this request. Only UserTaskRun's\nmatching all criteria will be returned."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunstatus",children:"UserTaskRunStatus"})}),(0,r.jsx)(s.td,{children:"Status of UserTaskRun's to return."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_def_name"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"UserTaskDef name to search for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Search for UserTaskRun's assigned to this user id."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Search for UserTaskRun's assigned to this user group."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Search for UserTaskRun's that were created after this time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Search for UserTaskRun's that were created before this time."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchvariablerequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchVariableRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for Variables by their value. This request is also highly useful to search for\nWfRun's based on the value of Variable's that are not in the Entrypoint ThreadRun,\nand also when you are using LittleHorse as a data store and need to perform a search."}),"\n",(0,r.jsxs)(s.p,{children:["You may only search for a Variable that has an index specified on it. This may be done\nvia th ",(0,r.jsx)(s.code,{children:".searchable()"})," method on our SDK's."]}),"\n",(0,r.jsx)(s.p,{children:"Note that we do not yet support searching JSON_OBJ or JSON_ARR fields, but you may\nstill mark those fields as searchable. We will soon add the ability to query those\nfields via the indices."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Specifies the value that the variable must be. Exact match is required."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Specifies major version of the WfSpec for the associated WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_revision"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Specifies the revision of the WfSpec for the associated WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"var_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Specifies the name of the variable to search for. This is required."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Specifies the name of the WfSpec for the associated WfRun's. This is required."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchwfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"A request used to retrieve a list of WfRunId's by certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The WfSpec whose WfRun's we are searching for. This is required."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Specifies to return only WfRun's from this WfSpec Major Version."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_revision"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Specifies to return only WfRun's from this WfSpec Revision. Can only be set if wf_spec_major_version is also set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"Specifies to return only WfRun's matching this status."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only WfRun's that started after this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only WfRun's that started before this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variable_filters"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablematch",children:"VariableMatch"})}),(0,r.jsx)(s.td,{children:"Allows filtering WfRun's based on the value of the Variables. This ONLY works for the Variables in the entrypiont threadrun (that is, variables where the threadRunNumber == 0)."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchwfspecrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchWfSpecRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for WfSpec's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"wf_spec_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Return WfSpec's with a specific name."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"wf_spec_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Return WfSpec's with a specific prefix."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_name"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"wf_spec_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Return all WfSpec's that make use of a given TaskDef."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"serverversionresponse",children:["Message ",(0,r.jsx)(s.code,{children:"ServerVersionResponse"})]}),"\n",(0,r.jsx)(s.p,{children:"The version of the LH Server according to Semantic Versioning"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Server Major Version"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"minor_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Server Minor Version"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"patch_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Server Patch Version"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"pre_release_identifier"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Prerelease Identifier. If this is set, then the server is NOT a production release but rather a release candidate or experimental pre-release."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"stopwfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"StopWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Message to HALT a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"Is the WfRunId"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The number of the ThreadRun to halt. Note that halting the entrypoint ThreadRun (which always has number ",(0,r.jsx)(s.code,{children:"0"}),") causes the whole WfRun to halt. If you do not manually set the thread_run_number field, it defaults to zero, so stopping the entire WfRun is the default behavior."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefidlist",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of TaskDef Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefmetrics",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefMetrics"})]}),"\n",(0,r.jsx)(s.p,{children:"Metrics for a TaskDef in a certain time period."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"TaskDef that the metrics apply to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"When the window started."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"Length of the window."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"schedule_to_start_max"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Longest time that a TaskRun was in the TASK_SCHEDULED state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"schedule_to_start_avg"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Average time that a TaskRun was in the TASK_SCHEDULED state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_to_complete_max"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Longest time between a TaskRun being started and completed"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_to_complete_avg"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Average time between a TaskRun being started and completed"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_completed"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of TaskRun's that reached the TASK_SUCCESS state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_errored"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of TaskRun's that reached the TASK_ERROR state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_started"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of TaskRun's that transitioned to the TASK_RUNNING state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_scheduled"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of TaskRun's that were scheduled"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefmetricsqueryrequest",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefMetricsQueryRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Query to retrieve a specific TaskDef Metrics Window."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["Return the window ",(0,r.jsx)(s.em,{children:"containing"})," this timestamp. The window start is not guaranteed to align perfectly with the request."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The window size"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_name"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the specific TaskDef for which we are calculating metrics."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskrunidlist",children:["Message ",(0,r.jsx)(s.code,{children:"TaskRunIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of TaskRun ID's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskrunlist",children:["Message ",(0,r.jsx)(s.code,{children:"TaskRunList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of TaskRun's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrun",children:"TaskRun"})}),(0,r.jsx)(s.td,{children:"A list of TaskRun Objects"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskworkergroup",children:["Message ",(0,r.jsx)(s.code,{children:"TaskWorkerGroup"})]}),"\n",(0,r.jsx)(s.p,{children:"Describes all workers registered for a specific TaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskworkergroupid",children:"TaskWorkerGroupId"})}),(0,r.jsx)(s.td,{children:"Identifier for the group."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Timestamp indicating when the worker group was initially registered."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_workers"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskworkergrouptaskworkersentry",children:"TaskWorkerGroup.TaskWorkersEntry"})}),(0,r.jsx)(s.td,{children:"Metadata grouped by ClientId string."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskworkergrouptaskworkersentry",children:["Message ",(0,r.jsx)(s.code,{children:"TaskWorkerGroup.TaskWorkersEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskworkermetadata",children:"TaskWorkerMetadata"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskworkerheartbeatrequest",children:["Message ",(0,r.jsx)(s.code,{children:"TaskWorkerHeartBeatRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Message used by Task Worker to register itself to the server and ask for assignments of\nservers to poll."}),"\n",(0,r.jsx)(s.p,{children:"Used by the Task Worker SDK; generally, you shouldn't have to touch this manually."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"client_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"listener_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskworkermetadata",children:["Message ",(0,r.jsx)(s.code,{children:"TaskWorkerMetadata"})]}),"\n",(0,r.jsx)(s.p,{children:"Describes a specific task worker"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_worker_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"User-defined identifier for the worker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_heartbeat"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Timestamp indicating the last heartbeat sent by the worker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"hosts"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhhostinfo",children:"LHHostInfo"})}),(0,r.jsx)(s.td,{children:"The host(s) where the worker is polling tasks"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"tenantidlist",children:["Message ",(0,r.jsx)(s.code,{children:"TenantIdList"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenantid",children:"TenantId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskdefidlist",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskDefIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of UserTaskDef Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdefid",children:"UserTaskDefId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskrunidlist",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskRunIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of UserTaskRun Id's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskrunlist",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskRunList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of UserTaskRuns"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrun",children:"UserTaskRun"})}),(0,r.jsx)(s.td,{children:"A list of UserTaskRun Objects"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"variableidlist",children:["Message ",(0,r.jsx)(s.code,{children:"VariableIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"This is a list of Variable ID's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableid",children:"VariableId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variablelist",children:["Message ",(0,r.jsx)(s.code,{children:"VariableList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of Variables."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variable",children:"Variable"})}),(0,r.jsx)(s.td,{children:"A list of Variable objects."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"variablematch",children:["Message ",(0,r.jsx)(s.code,{children:"VariableMatch"})]}),"\n",(0,r.jsx)(s.p,{children:"Used by a SearchWfRunRequest to filter WfRun's and only return those whose Variable's\nmatch a certain filter."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"var_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the variable to inspect."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The value that the Variable must have in order to satisfy this VariableMatch"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfrunidlist",children:["Message ",(0,r.jsx)(s.code,{children:"WfRunIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of WfRun Id's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecidlist",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of WfSpec Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecmetrics",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecMetrics"})]}),"\n",(0,r.jsx)(s.p,{children:"Metrics for a WfSpec in a specific time window"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The WfSpecId that these metrics analyze"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time that the window started"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The length of the window"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_started"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of WfRun's created for this WfSpec"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_completed"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of WfRun's that reached the COMPLETED state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_errored"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of WfRun's that reached the ERROR state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_to_complete_max"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Longest time between a WfRun being started and reaching the COMPLETED state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_to_complete_avg"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Average time that a WfRun took to reach the COMPLETED state"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecmetricsqueryrequest",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecMetricsQueryRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Query to retrieve a specific WfSpec Metrics Window."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"WfSpecId of metrics to get."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["Return the window ",(0,r.jsx)(s.em,{children:"containing"})," this timestamp. The window start is not guaranteed to align perfectly with the request."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_length"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The window size"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdef",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDef"})]}),"\n",(0,r.jsx)(s.p,{children:"A TaskDef defines a blueprint for a TaskRun that can be dispatched to Task Workers."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The ID of this TaskDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"input_vars"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabledef",children:"VariableDef"})}),(0,r.jsx)(s.td,{children:"The input variables required to execute this TaskDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time at which this TaskDef was created."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"schema_output"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefoutputschema",children:"TaskDefOutputSchema"})}),(0,r.jsx)(s.td,{children:"Schema that validates the TaskDef's output"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefoutputschema",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefOutputSchema"})]}),"\n",(0,r.jsx)(s.p,{children:"Schema that validates the TaskDef's output"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value_def"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabledef",children:"VariableDef"})}),(0,r.jsx)(s.td,{children:"The definition for the output content"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"lhtaskerror",children:["Message ",(0,r.jsx)(s.code,{children:"LHTaskError"})]}),"\n",(0,r.jsx)(s.p,{children:"Message denoting a TaskRun failed for technical reasons."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lherrortype",children:"LHErrorType"})}),(0,r.jsx)(s.td,{children:"The technical error code."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"message"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Human readable message for debugging."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"lhtaskexception",children:["Message ",(0,r.jsx)(s.code,{children:"LHTaskException"})]}),"\n",(0,r.jsx)(s.p,{children:"Message denoting a TaskRun's execution signaled that something went wrong in the\nbusiness process, throwing a littlehorse 'EXCEPTION'."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:'The user-defined Failure name, for example, "credit-card-declined"'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"message"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Human readadble description of the failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskattempt",children:["Message ",(0,r.jsx)(s.code,{children:"TaskAttempt"})]}),"\n",(0,r.jsx)(s.p,{children:"A single time that a TaskRun was scheduled for execution on a Task Queue."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"log_output"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsxs)(s.td,{children:["Optional information provided by the Task Worker SDK for debugging. Usually, if set it contains a stacktrace or it contains information logged via ",(0,r.jsx)(s.code,{children:"WorkerContext#log()"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"schedule_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the TaskAttempt was scheduled on the Task Queue. Not set for a TaskAttempt that is in the TASK_PENDING status; for example, when waiting between retries with exponential backoff."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the TaskAttempt was pulled off the queue and sent to a TaskWorker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"end_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the TaskAttempt was finished (either completed, reported as failed, or timed out)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_worker_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_worker_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The version of the Task Worker that executed the TaskAttempt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskstatus",children:"TaskStatus"})}),(0,r.jsx)(s.td,{children:"The status of this TaskAttempt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"output"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Denotes the Task Function executed properly and returned an output."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"error"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhtaskerror",children:"LHTaskError"})}),(0,r.jsx)(s.td,{children:"An unexpected technical error was encountered. May or may not be retriable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exception"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhtaskexception",children:"LHTaskException"})}),(0,r.jsx)(s.td,{children:"The Task Function encountered a business problem and threw a technical exception."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"masked_value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Indicates whether the result of the attempt field has been masked"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"tasknodereference",children:["Message ",(0,r.jsx)(s.code,{children:"TaskNodeReference"})]}),"\n",(0,r.jsx)(s.p,{children:"Reference to a NodeRun of type TASK which caused a TaskRun to be scheduled."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the NodeRun which caused this TASK to be scheduled."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskrun",children:["Message ",(0,r.jsx)(s.code,{children:"TaskRun"})]}),"\n",(0,r.jsx)(s.p,{children:"A TaskRun resents a single instance of a TaskDef being executed."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the TaskRun. Note that the TaskRunId contains the WfRunId."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the TaskDef being executed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"attempts"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskattempt",children:"TaskAttempt"})}),(0,r.jsx)(s.td,{children:"All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of the TaskRun being put on a Task Queue to be executed by the Task Workers."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"input_variables"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#varnameandval",children:"VarNameAndVal"})}),(0,r.jsx)(s.td,{children:"The input variables to pass into this TaskRun. Note that this is a list and not a map, because ordering matters. Depending on the language implementation, not every LittleHorse Task Worker SDK has the ability to determine the names of the variables from the method signature, so we provide both names and ordering."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"source"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunsource",children:"TaskRunSource"})}),(0,r.jsx)(s.td,{children:"The source (in the WfRun) that caused this TaskRun to be created. Currently, this can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such as a task used to send reminders)."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"scheduled_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"When the TaskRun was scheduled."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskstatus",children:"TaskStatus"})}),(0,r.jsx)(s.td,{children:"The status of the TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"timeout_seconds"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The timeout before LH considers a TaskAttempt to be timed out."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_attempts"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The maximum number of attempts that may be scheduled for this TaskRun. NOTE: setting total_attempts to 1 means that there are no retries."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exponential_backoff"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#exponentialbackoffretrypolicy",children:"ExponentialBackoffRetryPolicy"})}),(0,r.jsx)(s.td,{children:"Optional backoff policy ."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskrunsource",children:["Message ",(0,r.jsx)(s.code,{children:"TaskRunSource"})]}),"\n",(0,r.jsx)(s.p,{children:"The source of a TaskRun; i.e. why it was scheduled."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_node"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"task_run_source"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tasknodereference",children:"TaskNodeReference"})}),(0,r.jsx)(s.td,{children:"Reference to a NodeRun of type TASK which scheduled this TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_trigger"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"task_run_source"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertasktriggerreference",children:"UserTaskTriggerReference"})}),(0,r.jsx)(s.td,{children:"Reference to the specific UserTaskRun trigger action which scheduled this TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so that the WorkerContext can know this information."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"varnameandval",children:["Message ",(0,r.jsx)(s.code,{children:"VarNameAndVal"})]}),"\n",(0,r.jsx)(s.p,{children:"A key-value pair of variable name and value."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"var_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The variable name."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The value of the variable for this TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"masked"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsxs)(s.td,{children:["Indicates whether the content of the ",(0,r.jsx)(s.code,{children:"value"})," field has been masked"]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"assignusertaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"AssignUserTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Re-Assigns a UserTaskRun to a specific userId or userGroup."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The UserTaskRun to assign to a new user_id or user_group."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"override_claim"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"If override_claim is set to false and the UserTaskRun is already assigned to a user_id, then the request throws a FAILED_PRECONDITION error. If set to true, then the old claim is overriden and the UserTaskRun is assigned to the new user."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The new user_group to which the UserTaskRun is assigned. If not set, then the user_group of the UserTaskRun is actively unset by this request. At least one of the user_group and user_id must be set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The new user_id to which the UserTaskRun is assigned. If not set, then the user_id of the UserTaskRun is actively unset by this request. At least one of the user_group and user_id must be set."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"cancelusertaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"CancelUserTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Cancels a UserTaskRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The id of the UserTaskRun to cancel."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"completeusertaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"CompleteUserTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Completes a UserTaskRun with provided values."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The id of UserTaskRun to complete."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#completeusertaskrunrequestresultsentry",children:"CompleteUserTaskRunRequest.ResultsEntry"})}),(0,r.jsx)(s.td,{children:"A map from UserTaskField.name to a VariableValue containing the results of the user filling out the form."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The ID of the user who executed the task."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"completeusertaskrunrequestresultsentry",children:["Message ",(0,r.jsx)(s.code,{children:"CompleteUserTaskRunRequest.ResultsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"saveusertaskrunprogressrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SaveUserTaskRunProgressRequest"})]}),"\n",(0,r.jsxs)(s.p,{children:["Saves the results of a UserTaskRun and logs who saved the content.",(0,r.jsx)("br",{})]}),"\n",(0,r.jsxs)("li",{children:[" Throws FAILED_PRECONDITION if the UserTaskRun is in the ",(0,r.jsx)(s.code,{children:"DONE"})," or ",(0,r.jsx)(s.code,{children:"CANCELLED"})," state."]}),"\n",(0,r.jsxs)("li",{children:[" If ",(0,r.jsx)(s.code,{children:"policy"})," is set to ",(0,r.jsx)(s.code,{children:"FAIL_IF_CLAIMED_BY_OTHER"}),", returns ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"})," if the\n",(0,r.jsx)(s.code,{children:"user_id"})," field of the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," does not match the ",(0,r.jsx)(s.code,{children:"user_id"})," of the request."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The id of UserTaskRun to save."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#saveusertaskrunprogressrequestresultsentry",children:"SaveUserTaskRunProgressRequest.ResultsEntry"})}),(0,r.jsx)(s.td,{children:"A map from UserTaskField.name to a VariableValue containing the results of the user filling out the form."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The ID of the user who saved the task."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"policy"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#saveusertaskrunprogressrequestsaveusertaskrunassignmentpolicy",children:"SaveUserTaskRunProgressRequest.SaveUserTaskRunAssignmentPolicy"})}),(0,r.jsxs)(s.td,{children:["Configures how to handle ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," ownership when saving it."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"saveusertaskrunprogressrequestresultsentry",children:["Message ",(0,r.jsx)(s.code,{children:"SaveUserTaskRunProgressRequest.ResultsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskdef",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskDef"})]}),"\n",(0,r.jsx)(s.p,{children:"UserTaskDef is the metadata blueprint for UserTaskRuns."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["The name of the ",(0,r.jsx)(s.code,{children:"UserTaskDef"})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The version of the ",(0,r.jsx)(s.code,{children:"UserTaskDef"}),". Only simple versioning is supported."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"description"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Metadata field that does not impact WfRun execution. Useful for providing context on the UserTaskRun, for example when displaying it on a general-purpose task manager application."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"fields"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskfield",children:"UserTaskField"})}),(0,r.jsx)(s.td,{children:"These are the fields comprise the User Task. A User Task Manager application, or any application used to complete a UserTaskRun, should inspect these fields and display form entries for each one."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the UserTaskRun was created."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskevent",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent"})]}),"\n",(0,r.jsxs)(s.p,{children:["This is an event stored in the audit log of a ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," purely for observability\npurposes."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"the time the event occurred."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_executed"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"event"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskeventutetaskexecuted",children:"UserTaskEvent.UTETaskExecuted"})}),(0,r.jsx)(s.td,{children:"Denotes that a TaskRun was scheduled via a trigger."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"assigned"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"event"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskeventuteassigned",children:"UserTaskEvent.UTEAssigned"})}),(0,r.jsx)(s.td,{children:"Denotes that the UserTaskRun was assigned."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"cancelled"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"event"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskeventutecancelled",children:"UserTaskEvent.UTECancelled"})}),(0,r.jsx)(s.td,{children:"Denotes that the UserTaskRun was cancelled."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"saved"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"event"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskeventutesaved",children:"UserTaskEvent.UTESaved"})}),(0,r.jsxs)(s.td,{children:["Denotes that the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," was saved."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskeventuteassigned",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent.UTEAssigned"})]}),"\n",(0,r.jsx)(s.p,{children:"Message denoting that the UserTaskRun was assigned."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"old_user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The user_id before the ownership change, if set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"old_user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The user_group before the ownership change, if set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The user_id after the ownership change, if set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The user_group after the ownership change, if set."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskeventutecancelled",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent.UTECancelled"})]}),"\n",(0,r.jsxs)(s.p,{children:["Empty message used to denote that the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," was cancelled."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"message"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskeventutesaved",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent.UTESaved"})]}),"\n",(0,r.jsxs)(s.p,{children:["Message to denote that the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," was saved."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The user_id of the user who saved the UserTaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskeventutesavedresultsentry",children:"UserTaskEvent.UTESaved.ResultsEntry"})}),(0,r.jsx)(s.td,{children:"The results that were saved."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskeventutesavedresultsentry",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent.UTESaved.ResultsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskeventutetaskexecuted",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent.UTETaskExecuted"})]}),"\n",(0,r.jsxs)(s.p,{children:["Message to denote that a ",(0,r.jsx)(s.code,{children:"TaskRun"})," was scheduled by a trigger for this UserTaskRun."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_run"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsxs)(s.td,{children:["The ",(0,r.jsx)(s.code,{children:"TaskRunId"})," of the scheduled ",(0,r.jsx)(s.code,{children:"TaskRun"})]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskfield",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskField"})]}),"\n",(0,r.jsx)(s.p,{children:"A UserTaskField is a specific field of data to be entered into a UserTaskRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the field. When a UserTaskRun is completed, the NodeOutput is a single-level JSON_OBJ. Each key is the name of the field. Must be unique."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabletype",children:"VariableType"})}),(0,r.jsx)(s.td,{children:"The type of the output. Must be a primitive type (STR, BOOL, INT, DOUBLE)."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"description"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optional description which can be displayed by the User Task UI application. Does not affect WfRun execution."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"display_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name to be displayed by the User Task UI application. Does not affect WfRun execution."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"required"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether this field is required for UserTaskRun completion."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskrun",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskRun"})]}),"\n",(0,r.jsxs)(s.p,{children:["A UserTaskRun is a running instance of a UserTaskDef. It is created when a\nThreadRun arrives at a Node of type ",(0,r.jsx)(s.code,{children:"USER_TASK"}),"."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the UserTaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdefid",children:"UserTaskDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the UserTaskDef that this UserTaskRun comes from."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["Denotes the UserTaskRun as belonging to a specific User Group.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"The ",(0,r.jsx)(s.code,{children:"user_group"})," does not refer to a group that is stored in LittleHorse; rather, it is the responsibility of the application to keep track of user/group identity and ensure that the user_group does indeed exist.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Either ",(0,r.jsx)(s.code,{children:"user_id"})," or ",(0,r.jsx)(s.code,{children:"user_group"})," or both are set at any time."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["Denotes the UserTaskRun as assigned to a specific User ID. If this is set, then the UserTaskRun is either in the ASSIGNED, DONE, or CANCELLED status.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"The ",(0,r.jsx)(s.code,{children:"user_id"})," does not refer to a User that is stored in LittleHorse; rather, it is the responsibility of the application to keep track of user identity and ensure that the user_id does indeed exist.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Either ",(0,r.jsx)(s.code,{children:"user_id"})," or ",(0,r.jsx)(s.code,{children:"user_group"})," or both are set at any time."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunresultsentry",children:"UserTaskRun.ResultsEntry"})}),(0,r.jsxs)(s.td,{children:["The results of the UserTaskRun. Empty if the UserTaskRun has not yet been completed. Each key in this map is the ",(0,r.jsx)(s.code,{children:"name"})," of a corresponding ",(0,r.jsx)(s.code,{children:"UserTaskField"})," on the UserTaskDef."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunstatus",children:"UserTaskRunStatus"})}),(0,r.jsx)(s.td,{children:"Status of the UserTaskRun. Can be UNASSIGNED, ASSIGNED, DONE, or CANCELLED."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"events"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskevent",children:"UserTaskEvent"})}),(0,r.jsx)(s.td,{children:"A list of events that have happened. Used for auditing information."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"notes"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["Notes about this UserTaskRun that are ",(0,r.jsx)(s.strong,{children:"specific to the WfRun"}),". These notes are set by the WfSpec based on variables inside the specific ",(0,r.jsx)(s.code,{children:"WfRun"})," and are intended to be displayed on the User Task Manager application. They do not affect WfRun execution."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"scheduled_time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time that the UserTaskRun was created/scheduled."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:"The NodeRun with which the UserTaskRun is associated."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"epoch"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Current observed epoch of the UserTaskRun, related to the number of times it has been updated or re-assigned. Used internally to implement automated reassignment and reminder tasks."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskrunresultsentry",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskRun.ResultsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertasktriggerreference",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskTriggerReference"})]}),"\n",(0,r.jsx)(s.p,{children:'All TaskRun\'s have a "trigger reference" which refers to the WfRun Element that\ncaused the TaskRun to be scheduled. For example, a TaskRun on a regular TASK_NODE\nhas a TaskNodeReference.'}),"\n",(0,r.jsx)(s.p,{children:'The UserTaskTriggerReference serves as the "Trigger Reference" for a TaskRun that\nwas scheduled by a lifecycle hook on a UserTaskRun (eg. a reminder task).'}),"\n",(0,r.jsx)(s.p,{children:"The UserTaskTriggerReference is most useful in the WorkerContext of the Task Worker\nSDK, which allows the Task Method to determine where the TaskRun comes from."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:"Is the NodeRun that the UserTaskRun belongs to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_event_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["Is the index in the ",(0,r.jsx)(s.code,{children:"events"})," field of the UserTaskRun that the TaskRun corresponds to."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Is the user_id that the UserTaskRun is assigned to. Unset if UserTaskRun is not asigned to a specific user_id."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Is the user_id that the UserTaskRun is assigned to. Unset if UserTaskRun is not asigned to a specific user_id."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variable",children:["Message ",(0,r.jsx)(s.code,{children:"Variable"})]}),"\n",(0,r.jsx)(s.p,{children:"A Variable is an instance of a variable assigned to a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableid",children:"VariableId"})}),(0,r.jsx)(s.td,{children:"ID of this Variable. Note that the VariableId contains the relevant WfRunId inside it, the threadRunNumber, and the name of the Variabe."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The value of this Variable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"When the Variable was created."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfSpec that this Variable belongs to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"masked"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Marks a variable to show masked values"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variablevalue",children:["Message ",(0,r.jsx)(s.code,{children:"VariableValue"})]}),"\n",(0,r.jsx)(s.p,{children:"VariableValue is a structure containing a value in LittleHorse. It can be\nused to pass input variables into a WfRun/ThreadRun/TaskRun/etc, as output\nfrom a TaskRun, as the value of a WfRun's Variable, etc."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"json_obj"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"A String representing a serialized json object."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"json_arr"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"A String representing a serialized json list."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"double"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"double"}),(0,r.jsx)(s.td,{children:"A 64-bit floating point number."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bool"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"A boolean."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"str"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"A string."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"int"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsxs)(s.td,{children:["The ",(0,r.jsx)(s.code,{children:"INT"})," variable type is stored as a 64-bit integer. The ",(0,r.jsx)(s.code,{children:"INT"})," can be cast to a ",(0,r.jsx)(s.code,{children:"DOUBLE"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bytes"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"An arbitrary String of bytes."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"failurebeinghandled",children:["Message ",(0,r.jsx)(s.code,{children:"FailureBeingHandled"})]}),"\n",(0,r.jsx)(s.p,{children:"Points to the Failure that is currently being handled in the ThreadRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The thread run number."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_position"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The position of the NodeRun causing the failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The number of the failure."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"handlingfailurehaltreason",children:["Message ",(0,r.jsx)(s.code,{children:"HandlingFailureHaltReason"})]}),"\n",(0,r.jsx)(s.p,{children:"A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is being run."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handler_thread_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The ID of the Failure Handler ThreadRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"interrupted",children:["Message ",(0,r.jsx)(s.code,{children:"Interrupted"})]}),"\n",(0,r.jsx)(s.p,{children:"A Halt Reason denoting that a ThreadRun is halted because it is waiting for the\ninterrupt handler threadRun to run."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"interrupt_thread_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The ID of the Interrupt Handler ThreadRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"manualhalt",children:["Message ",(0,r.jsx)(s.code,{children:"ManualHalt"})]}),"\n",(0,r.jsxs)(s.p,{children:["A Halt Reason denoting that a ThreadRun was halted manually, via the ",(0,r.jsx)(s.code,{children:"rpc StopWfRun"})," request."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"meaning_of_life"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Nothing to store."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"parenthalted",children:["Message ",(0,r.jsx)(s.code,{children:"ParentHalted"})]}),"\n",(0,r.jsx)(s.p,{children:"A Halt Reason denoting that a ThreadRun is halted because its parent is also HALTED."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_thread_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The ID of the halted parent."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"pendingfailurehandler",children:["Message ",(0,r.jsx)(s.code,{children:"PendingFailureHandler"})]}),"\n",(0,r.jsx)(s.p,{children:"Represents a Failure Handler that is pending to be run."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failed_thread_run"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The ThreadRun that failed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handler_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to run to handle the failure."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"pendingfailurehandlerhaltreason",children:["Message ",(0,r.jsx)(s.code,{children:"PendingFailureHandlerHaltReason"})]}),"\n",(0,r.jsxs)(s.p,{children:["A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is ",(0,r.jsx)(s.em,{children:"enqueued"})," to be\nrun."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_position"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The position of the NodeRun which threw the failure."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"pendinginterrupt",children:["Message ",(0,r.jsx)(s.code,{children:"PendingInterrupt"})]}),"\n",(0,r.jsx)(s.p,{children:"Represents an ExternalEvent that has a registered Interrupt Handler for it\nand which is pending to be sent to the relevant ThreadRun's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEvent triggering the Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handler_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to run to handle the Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"interrupted_thread_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The ID of the ThreadRun to interrupt. Must wait for this ThreadRun to be HALTED before running the Interrupt Handler."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"pendinginterrupthaltreason",children:["Message ",(0,r.jsx)(s.code,{children:"PendingInterruptHaltReason"})]}),"\n",(0,r.jsx)(s.p,{children:"A Halt Reason denoting that a ThreadRun is halted while waiting for an Interrupt handler\nto be run."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"The ExternalEventId that caused the Interrupt."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadhaltreason",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadHaltReason"})]}),"\n",(0,r.jsxs)(s.p,{children:["Denotes a reason why a ThreadRun is halted. See ",(0,r.jsx)(s.code,{children:"ThreadRun.halt_reasons"})," for context."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_halted"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#parenthalted",children:"ParentHalted"})}),(0,r.jsx)(s.td,{children:"Parent threadRun halted."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"interrupted"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#interrupted",children:"Interrupted"})}),(0,r.jsx)(s.td,{children:"Handling an Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"pending_interrupt"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#pendinginterrupthaltreason",children:"PendingInterruptHaltReason"})}),(0,r.jsx)(s.td,{children:"Waiting to handle Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"pending_failure"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#pendingfailurehandlerhaltreason",children:"PendingFailureHandlerHaltReason"})}),(0,r.jsx)(s.td,{children:"Waiting to handle a failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handling_failure"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#handlingfailurehaltreason",children:"HandlingFailureHaltReason"})}),(0,r.jsx)(s.td,{children:"Handling a failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"manual_halt"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#manualhalt",children:"ManualHalt"})}),(0,r.jsx)(s.td,{children:"Manually stopped the WfRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadrun",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadRun"})]}),"\n",(0,r.jsx)(s.p,{children:"A ThreadRun is a running thread of execution within a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The current WfSpecId of this ThreadRun. This must be set explicitly because during a WfSpec Version Migration, it is possible for different ThreadSpec's to have different WfSpec versions."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The number of the ThreadRun. This is an auto-incremented integer corresponding to the chronological ordering of when the ThreadRun's were created. If you have not configured any retention policy for the ThreadRun's (i.e. never clean them up), then this also corresponds to the position of the ThreadRun in the WfRun's ",(0,r.jsx)(s.code,{children:"thread_runs"})," list."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"The status of the ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec being run."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the ThreadRun was started."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"end_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the ThreadRun was completed or failed. Unset if still active."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"error_message"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Human-readable error message detailing what went wrong in the case of a failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"child_thread_ids"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"List of thread_run_number's for all child thread_runs."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_thread_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"halt_reasons"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadhaltreason",children:"ThreadHaltReason"})}),(0,r.jsx)(s.td,{children:'If the ThreadRun is HALTED, this contains a list of every reason for which the ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list), then the ThreadRun will return to the RUNNING state.'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"interrupt_trigger_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the ExternalEvent that caused the Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_being_handled"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failurebeinghandled",children:"FailureBeingHandled"})}),(0,r.jsx)(s.td,{children:"If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure that is being handled by this ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"current_node_position"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["This is the current ",(0,r.jsx)(s.code,{children:"position"})," of the current NodeRun being run. This is an auto-incremented field that gets incremented every time we run a new NodeRun."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handled_failed_children"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["List of every child ThreadRun which both a) failed, and b) was properly handled by a Failure Handler.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),'This is important because at the EXIT node, if a Child ThreadRun was discovered to have failed, then this ThreadRun (the parent) also fails with the same failure as the child. If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun\'s number is appended to this list, and then the EXIT node ignores that ThreadRun.']})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadtype",children:"ThreadType"})}),(0,r.jsx)(s.td,{children:"The Type of this ThreadRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfrun",children:["Message ",(0,r.jsx)(s.code,{children:"WfRun"})]}),"\n",(0,r.jsx)(s.p,{children:"A WfRun is a running instance of a WfSpec."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfSpec that this WfRun belongs to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"old_wf_spec_versions"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the old WfSpecId to this list for historical auditing and debugging purposes."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"The status of this WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"greatest_threadrun_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The ID number of the greatest ThreadRUn in this WfRun. The total number of ThreadRuns is given by greatest_thread_run_number + 1.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Introduced now since with ThreadRun-level retention, we can't rely upon thread_runs.size() to determine the number of ThreadRuns, as a ThreadRun is removed from the thread_runs list once its retention period expires."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the WfRun was started."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"end_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the WfRun failed or completed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_runs"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadrun",children:"ThreadRun"})}),(0,r.jsx)(s.td,{children:"A list of all active ThreadRun's and terminated ThreadRun's whose retention periods have not yet expired."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"pending_interrupts"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#pendinginterrupt",children:"PendingInterrupt"})}),(0,r.jsx)(s.td,{children:"A list of Interrupt events that will fire once their appropriate ThreadRun's finish halting."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"pending_failures"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#pendingfailurehandler",children:"PendingFailureHandler"})}),(0,r.jsx)(s.td,{children:"A list of pending failure handlers which will fire once their appropriate ThreadRun's finish halting."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"edge",children:["Message ",(0,r.jsx)(s.code,{children:"Edge"})]}),"\n",(0,r.jsx)(s.p,{children:"The Edge is the line in the workflow that connects one Node to another."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"sink_node_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the Node that the Edge points to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"condition"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#edgecondition",children:"EdgeCondition"})}),(0,r.jsxs)(s.td,{children:["The Condition on which this Edge will be traversed. When choosing an Edge to travel after the completion of a NodeRun, the Edges are evaluated in order. The first one to either have no condition or have a condition which evaluates to ",(0,r.jsx)(s.code,{children:"true"})," is taken."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variable_mutations"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablemutation",children:"VariableMutation"})}),(0,r.jsx)(s.td,{children:"Ordered list of Variable Mutations to execute when traversing this Edge."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"edgecondition",children:["Message ",(0,r.jsx)(s.code,{children:"EdgeCondition"})]}),"\n",(0,r.jsx)(s.p,{children:"This is a boolean expression used to evaluate whether an Edge is valid."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"comparator"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#comparator",children:"Comparator"})}),(0,r.jsx)(s.td,{children:"The Operator used to evaluate the left versus the right."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"left"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"The left side of the boolean expression."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"right"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"The right side of the Boolean Expression."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"entrypointnode",children:["Message ",(0,r.jsx)(s.code,{children:"EntrypointNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines the beginning of the ThreadRun execution."}),"\n",(0,r.jsx)(s.p,{children:"Output is NULL"}),"\n",(0,r.jsxs)(s.h3,{id:"exitnode",children:["Message ",(0,r.jsx)(s.code,{children:"ExitNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines the end of the ThreadRun execution."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_def"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failuredef",children:"FailureDef"})}),(0,r.jsxs)(s.td,{children:["If set, this ExitNode throws the specified Failure upon arrival. Note that Failures are propagated up to the parent ThreadRun (or cause the entire WfRun to fail if sent by the entrypoint ThreadRun).",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If this is not set, then a ThreadRun arriving at this Exit Node will be COMPLETED."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventnode",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventNode"})]}),"\n",(0,r.jsx)(s.p,{children:"An ExternalEventNode causes the WfRun to stop and wait for an ExternalEvent\nto arrive before continuing onwards."}),"\n",(0,r.jsx)(s.p,{children:"The output is just the content of the ExternalEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEventDef that we are waiting for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"timeout_seconds"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Determines the maximum amount of time that the NodeRun will wait for the ExternalEvent to arrive."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"failuredef",children:["Message ",(0,r.jsx)(s.code,{children:"FailureDef"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines a Failure that can be thrown."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The code for the failure. If in UPPER_CASE, it must be one of the LHErrorType enums, and represents an ERROR. If it is in kebab-case, then it is a user-defined EXCEPTION."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"message"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Human-readable message denoting why the Failure occurred."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"If specified, the thrown Failure will have this content."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"failurehandlerdef",children:["Message ",(0,r.jsx)(s.code,{children:"FailureHandlerDef"})]}),"\n",(0,r.jsx)(s.p,{children:"Specifies a Failure Handler which can run in case of a certain Failure to allow\nthe ThreadRun to run compensatory logic and gracefully continue rather than\nfailing immediately."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handler_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to run as a"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"specific_failure"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"failure_to_catch"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["Specifies that this FailureHandlerDef will be triggered for a Failure with this exact name.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If this and ",(0,r.jsx)(s.code,{children:"specific_failure"})," are both unset, then any failure is caught."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"any_failure_of_type"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"failure_to_catch"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failurehandlerdeflhfailuretype",children:"FailureHandlerDef.LHFailureType"})}),(0,r.jsx)(s.td,{children:"Specifies that this FailureHandlerDef will be triggered for any failure matching this type (ERROR or EXCEPTION)."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"interruptdef",children:["Message ",(0,r.jsx)(s.code,{children:"InterruptDef"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines an Interrupt for a ThreadSpec. An Interrupt means that when an ExternalEvent\nof a certain type is registered to the WfRun, then the affected ThreadRun is HALTED\nand a handler ThreadRun is run as an interrupt handler. The interrupted ThreadRun\nis resumed once the interrupt handler completes."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEventDef which triggers an Interrupt for this ThreadSpec. Note that as of 0.9.0, you cannot use an ExternalEventDefId for both an InterruptDef and an ExternalEventNode in the same WfSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handler_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec that we run as the interrupt handler."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"jsonindex",children:["Message ",(0,r.jsx)(s.code,{children:"JsonIndex"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines an index to make a JSON_OBJ or JSON_ARR variable searchable over a specific\nJSON Path."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"field_path"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Denotes the path in JSONPath format (according to the Java Jayway library) that has a field we should index."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"field_type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabletype",children:"VariableType"})}),(0,r.jsx)(s.td,{children:"Is the type of the field we are indexing."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"node",children:["Message ",(0,r.jsx)(s.code,{children:"Node"})]}),"\n",(0,r.jsx)(s.p,{children:"A Node is a step in a ThreadRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"outgoing_edges"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#edge",children:"Edge"})}),(0,r.jsx)(s.td,{children:"Defines the flow of execution and determines where the ThreadRun goes next."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_handlers"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failurehandlerdef",children:"FailureHandlerDef"})}),(0,r.jsx)(s.td,{children:"Specifies handlers for failures (EXCEPTION or ERROR or both) which might be thrown by the NodeRun. If a Failure is thrown by the Node execution, then the first matching Failure Handler (if present) is run. If there is a matching Failure Handler and it runs to completion, then the ThreadRun advances from the Node; else, it fails."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"entrypoint"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#entrypointnode",children:"EntrypointNode"})}),(0,r.jsx)(s.td,{children:"Creates an EntrypointRun. Every ThreadRun has one Entrypoint node."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exit"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#exitnode",children:"ExitNode"})}),(0,r.jsx)(s.td,{children:"Creates an `ExitRun``. Every ThreadSpec has at least one Exit Node."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tasknode",children:"TaskNode"})}),(0,r.jsx)(s.td,{children:"Creates a TaskNodeRUn"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventnode",children:"ExternalEventNode"})}),(0,r.jsx)(s.td,{children:"Creates an ExternalEventNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_thread"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startthreadnode",children:"StartThreadNode"})}),(0,r.jsx)(s.td,{children:"Creates a StartThreadNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wait_for_threads"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsnode",children:"WaitForThreadsNode"})}),(0,r.jsx)(s.td,{children:"Creates a WaitForThreadsNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"nop"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#nopnode",children:"NopNode"})}),(0,r.jsx)(s.td,{children:"Creates a NopNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"sleep"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#sleepnode",children:"SleepNode"})}),(0,r.jsx)(s.td,{children:"Creates a SleepNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertasknode",children:"UserTaskNode"})}),(0,r.jsx)(s.td,{children:"Creates a UserTaskNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_multiple_threads"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startmultiplethreadsnode",children:"StartMultipleThreadsNode"})}),(0,r.jsx)(s.td,{children:"Creates a StartMultipleThreadsNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"throw_event"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#throweventnode",children:"ThrowEventNode"})}),(0,r.jsx)(s.td,{children:"Creates a ThrowEventNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wait_for_condition"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforconditionnode",children:"WaitForConditionNode"})}),(0,r.jsx)(s.td,{children:"Creates a WaitForConditionRun"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"nodemigration",children:["Message ",(0,r.jsx)(s.code,{children:"NodeMigration"})]}),"\n",(0,r.jsx)(s.p,{children:"EXPERIMENTAL: Specification for migrating a WfRun from a Node in one WfSpec\nto a Node in another WfSpec version."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_node_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the Node on the new WfSpec to move to."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"nopnode",children:["Message ",(0,r.jsx)(s.code,{children:"NopNode"})]}),"\n",(0,r.jsx)(s.p,{children:"NOP node has no operations and is used for conditional branching."}),"\n",(0,r.jsxs)(s.h3,{id:"sleepnode",children:["Message ",(0,r.jsx)(s.code,{children:"SleepNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Sleep Node causes the WfRun to wait a specified time and then resume."}),"\n",(0,r.jsx)(s.p,{children:"There is no output."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"raw_seconds"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"sleep_length"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Sleeps the specified number of seconds."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"timestamp"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"sleep_length"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsxs)(s.td,{children:["Sleeps until the ",(0,r.jsx)(s.code,{children:"long"})," timestamp (epoch millis) specified here."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"iso_date"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"sleep_length"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Sleeps until the ISO-formatted date specified here."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startmultiplethreadsnode",children:["Message ",(0,r.jsx)(s.code,{children:"StartMultipleThreadsNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Iterates over a JSON_ARR and starts a Child ThreadRun for each element in the\nlist."}),"\n",(0,r.jsx)(s.p,{children:"Returns a JSON_ARR containing the thread_run_number of each spawned child."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to spawn."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startmultiplethreadsnodevariablesentry",children:"StartMultipleThreadsNode.VariablesEntry"})}),(0,r.jsx)(s.td,{children:"Variables which are passed into the child ThreadRuns. These assignments are the same for all spawned threads."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"iterable"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsxs)(s.td,{children:["Assignment that resolves to a JSON_ARR. For each element in the list, a child ThreadRun is started. The reserved ",(0,r.jsx)(s.code,{children:"INPUT"})," variable for each Child is set to the corresponding item in the list."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startmultiplethreadsnodevariablesentry",children:["Message ",(0,r.jsx)(s.code,{children:"StartMultipleThreadsNode.VariablesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startthreadnode",children:["Message ",(0,r.jsx)(s.code,{children:"StartThreadNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Starts a Child ThreadRun with a specific ThreadSpec."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to spawn."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startthreadnodevariablesentry",children:"StartThreadNode.VariablesEntry"})}),(0,r.jsx)(s.td,{children:"The input variables to pass into the Child ThreadRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startthreadnodevariablesentry",children:["Message ",(0,r.jsx)(s.code,{children:"StartThreadNode.VariablesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadretentionpolicy",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadRetentionPolicy"})]}),"\n",(0,r.jsx)(s.p,{children:"ThreadRetentionPolicy specifies how long to keep record of a ThreadRun and its associated\nNodeRun's and TaskRun's and Variables after the ThreadRun has been completed."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"seconds_after_thread_termination"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"thread_gc_policy"})]}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Delete associated ThreadRun's X seconds after they terminate, regardless of status."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadspec",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadSpec"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines a blueprint for a ThreadRun, which is a thread of execution inside a\nWfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"nodes"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadspecnodesentry",children:"ThreadSpec.NodesEntry"})}),(0,r.jsx)(s.td,{children:"The Nodes inside this ThreadSpec. Maps from name to Node."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variable_defs"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadvardef",children:"ThreadVarDef"})}),(0,r.jsx)(s.td,{children:"Defines Variables that are local to ThreadRun's of this ThreadSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"interrupt_defs"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#interruptdef",children:"InterruptDef"})}),(0,r.jsx)(s.td,{children:"Defines all interrupts for this ThreadSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retention_policy"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadretentionpolicy",children:"ThreadRetentionPolicy"})}),(0,r.jsx)(s.td,{children:"Optional retention policy to clean up ThreadRun's of this ThreadSpec after they have been completed. This is important for long-lived WfRun's that could have hundreds of ThreadRun's, because a ThreadRun has a record inside the WfRun itself."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadspecnodesentry",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadSpec.NodesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#node",children:"Node"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadspecmigration",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadSpecMigration"})]}),"\n",(0,r.jsx)(s.p,{children:"EXPERIMENTAL: Specification for how to migrate a ThreadRun of a specific ThreadSpec\nfrom one WfSpec to another WfSpec version."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec in the new WfSpec that this ThreadSpec should migrate to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_migrations"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadspecmigrationnodemigrationsentry",children:"ThreadSpecMigration.NodeMigrationsEntry"})}),(0,r.jsx)(s.td,{children:"Map from name of the nodes on the current ThreadSpec to the migration to perform on it to move it to a new WfSpec."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadspecmigrationnodemigrationsentry",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadSpecMigration.NodeMigrationsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#nodemigration",children:"NodeMigration"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadvardef",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadVarDef"})]}),"\n",(0,r.jsx)(s.p,{children:"Denotes a variable declaration at the ThreadSpec level."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"var_def"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabledef",children:"VariableDef"})}),(0,r.jsx)(s.td,{children:"Is the actual VariableDefinition containing name and type."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"required"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether the variable is required as input to the threadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"searchable"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether this variable has an index configured."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"json_indexes"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#jsonindex",children:"JsonIndex"})}),(0,r.jsx)(s.td,{children:"Valid for JSON_OBJ and JSON_ARR variables only. List of JSON fields to index."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"access_level"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunvariableaccesslevel",children:"WfRunVariableAccessLevel"})}),(0,r.jsx)(s.td,{children:"The Access Level of this variable."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"throweventnode",children:["Message ",(0,r.jsx)(s.code,{children:"ThrowEventNode"})]}),"\n",(0,r.jsx)(s.p,{children:"A SubNode that throws a WorkflowEvent of a specific type. There is no output."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{children:"The WorkflowEventDefId of the WorkflowEvent that is thrown"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"A VariableAssignment defining the content of the WorkflowEvent that is thrown"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertasknode",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskNode"})]}),"\n",(0,r.jsx)(s.p,{children:"The UserTaskNode creates a UserTaskRun, which is used to get input from a human\nuser into the workflow."}),"\n",(0,r.jsx)(s.p,{children:"The output is a JSON_OBJ variable with one key/value pair for each UserTaskField."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_def_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["Denotes the name of the ",(0,r.jsx)(s.code,{children:"UserTaskDef"})," that should create the ",(0,r.jsx)(s.code,{children:"UserTaskRun"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Denotes the user_group to which the UserTaskRun is assigned upon creation."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Denotes the user_id to which the UserTaskRun is assigned upon creation."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"actions"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#utactiontrigger",children:"UTActionTrigger"})}),(0,r.jsx)(s.td,{children:'Specifies a list of actions that happen on various time-based triggers. Actions include reassigning the UserTaskRun, cancelling the UserTaskRun, or executing a "reminder" TaskRun.'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_def_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"If set, then the UserTaskRun will always have this specific version of the UserTaskDef. Otherwise, the UserTaskRun will have the latest version."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"notes"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsxs)(s.td,{children:["Specifies the value to be displayed on the ",(0,r.jsx)(s.code,{children:"notes"})," field of the UserTaskRun."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"on_cancellation_exception_name"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Specifies the name of the exception thrown when the User Task is canceled. If not set, then the cancellation or timeout of a User Task Run throws an ERROR rather than an EXCEPTION."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforconditionnode",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForConditionNode"})]}),"\n",(0,r.jsx)(s.p,{children:"A SubNode that blocks until a condition is satisfied in the WfRun.\nThere is no output."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"condition"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#edgecondition",children:"EdgeCondition"})}),(0,r.jsx)(s.td,{children:"The condition that this node will block for."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforthreadsnode",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForThreadsNode"})]}),"\n",(0,r.jsxs)(s.p,{children:["Specifies that a ThreadRun will wait for certain specified Child ThreadRun's to\ncomplete or fail before the WfRun continues. If one of the Child ThreadRun's\nthrows a Failure that is not caught by the ",(0,r.jsx)(s.code,{children:"per_thread_failure_handlers"}),",\nthen the Child ThreadRun's Failure is thrown by the WaitForThreadsRun."]}),"\n",(0,r.jsx)(s.p,{children:"No output."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"threads"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"threads_to_wait_for"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsnodethreadstowaitfor",children:"WaitForThreadsNode.ThreadsToWaitFor"})}),(0,r.jsx)(s.td,{children:"Specifies that the WaitForThreadsRun will wait for the threads specified here."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_list"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"threads_to_wait_for"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsxs)(s.td,{children:["Specifies that the WaitForThreadsRun will wait for a list of ThreadRun's contained in the JSON_ARR value specified here. Each element in the list must be an INT representing the ",(0,r.jsx)(s.code,{children:"number"})," of a ThreadRun that we're waiting for."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"per_thread_failure_handlers"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failurehandlerdef",children:"FailureHandlerDef"})}),(0,r.jsxs)(s.td,{children:["If any of the child ThreadRun's that we are waiting for throw a Failure, we will evaluate it against these FailureHandlerDef's and run the first matching FailureHandler (if any). The FailureHandler will be a child of the child, which means that it has access to all of the variables in the scope of the failed Child ThreadRun.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"This is different from Node-level Failure Handlers, which would be ",(0,r.jsx)(s.em,{children:"siblings"})," of the ThreadRuns that we're waiting for, and would run only when the overall nodeRun has failed."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforthreadsnodethreadtowaitfor",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForThreadsNode.ThreadToWaitFor"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Causes the WaitForThreadsNodeRun to wait for the ThreadRun whose number matches the value specified here. Must resolve to an INT."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforthreadsnodethreadstowaitfor",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForThreadsNode.ThreadsToWaitFor"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"threads"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsnodethreadtowaitfor",children:"WaitForThreadsNode.ThreadToWaitFor"})}),(0,r.jsx)(s.td,{children:"Wait for one or more ThreadRun's"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspec",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpec"})]}),"\n",(0,r.jsxs)(s.p,{children:["A ",(0,r.jsx)(s.code,{children:"WfSpec"})," defines the logic for a workflow in LittleHorse. It is a metadata object\nand is a blueprint for a ",(0,r.jsx)(s.code,{children:"WfRun"})," execution."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsxs)(s.td,{children:["The ID of the ",(0,r.jsx)(s.code,{children:"WfSpec"}),". Note that this ID is versioned with both a major version and a minor revision. Creating new WfSpec's with the same name and different specifications results in a completely new ",(0,r.jsx)(s.code,{children:"WfSpec"})," object whose ",(0,r.jsx)(s.code,{children:"id.name"})," is the same but with different version."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["The timestamp at which the ",(0,r.jsx)(s.code,{children:"WfSpec"})," was created."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"frozen_variables"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadvardef",children:"ThreadVarDef"})}),(0,r.jsx)(s.td,{children:"Variables whose types cannot be changed without causing a Breaking Change between the versions."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metadatastatus",children:"MetadataStatus"})}),(0,r.jsxs)(s.td,{children:["The Status of the ",(0,r.jsx)(s.code,{children:"WfSpec"}),". Currently, only ",(0,r.jsx)(s.code,{children:"ACTIVE"})," exists. This field will be used in the future when de-commissioning a WfSpec gracefully."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_specs"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecthreadspecsentry",children:"WfSpec.ThreadSpecsEntry"})}),(0,r.jsxs)(s.td,{children:["The various ThreadSpec's in this ",(0,r.jsx)(s.code,{children:"WfSpec"}),". Each ",(0,r.jsx)(s.code,{children:"ThreadSpec"})," defines a blueprint for a parallel thread of execution (a ",(0,r.jsx)(s.code,{children:"ThreadRun"}),"). They are referred to by their names."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"entrypoint_thread_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["The name of the ",(0,r.jsx)(s.code,{children:"ENTRYPOINT"})," ThreadSpec. The Entrypoint is the ",(0,r.jsx)(s.code,{children:"ThreadSpec"})," for the Entrypoint ThreadRun, which is the ",(0,r.jsx)(s.code,{children:"ThreadRun"})," that is created upon starting the ",(0,r.jsx)(s.code,{children:"WfRun"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retention_policy"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workflowretentionpolicy",children:"WorkflowRetentionPolicy"})}),(0,r.jsxs)(s.td,{children:["Optional policy that configures cleaning up old ",(0,r.jsx)(s.code,{children:"WfRun"}),"'s after they are completed or failed. Recommended for production settings to avoid running out of disk space; unless you are using a ",(0,r.jsx)(s.code,{children:"WfRun"})," as a data record, in which case the application should clean up ",(0,r.jsx)(s.code,{children:"WfRun"}),"'s as appropriate."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"migration"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecversionmigration",children:"WfSpecVersionMigration"})}),(0,r.jsxs)(s.td,{children:["EXPERIMENTAL: ongoing migration from one version of a ",(0,r.jsx)(s.code,{children:"WfSpec"})," to another."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_spec"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecparentwfspecreference",children:"WfSpec.ParentWfSpecReference"})}),(0,r.jsx)(s.td,{children:"Reference to the parent WfSpec. If this is set, all WfRun's for this WfSpec must be the child of a WfRun belonging to the referenced WfSpec."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecparentwfspecreference",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpec.ParentWfSpecReference"})]}),"\n",(0,r.jsxs)(s.p,{children:["Reference to another WfSpec. If a WfSpec has a ParentWfSpecReference, then all\nWfRun's for that WfSpec ",(0,r.jsx)(s.em,{children:"MUST"})," be the child of a WfRun of the provided WfSpec; meaning\nthat the RunWf RPC must provide a ",(0,r.jsx)(s.code,{children:"parent_wf_run_id"})," that belongs to the specified\nWfSpec."]}),"\n",(0,r.jsx)(s.p,{children:"Currently, only reference by names is supported."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Name of the Parent WfSpec"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_major_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"FOR NOW: no validation of variables on parent. In the future we will pass wf_spec_major_version, but we should probably examine the rules for evolution in the future."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecthreadspecsentry",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpec.ThreadSpecsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadspec",children:"ThreadSpec"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecversionmigration",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecVersionMigration"})]}),"\n",(0,r.jsx)(s.p,{children:"EXPERIMENTAL: Specification for how to migrate an in-flight WfRun from one WfSpec\nto another WfSpec version."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_major_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The major version of the WfSpec that we are migrating to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_revision"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The revision of the WfSpec that we are migrating to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_migrations"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecversionmigrationthreadspecmigrationsentry",children:"WfSpecVersionMigration.ThreadSpecMigrationsEntry"})}),(0,r.jsx)(s.td,{children:"Map from ThreadSpec name to a specifier determining how to migrate ThreadRun's to the new version of the WfSpec."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecversionmigrationthreadspecmigrationsentry",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecVersionMigration.ThreadSpecMigrationsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadspecmigration",children:"ThreadSpecMigration"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"workflowretentionpolicy",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowRetentionPolicy"})]}),"\n",(0,r.jsx)(s.p,{children:"A WorkflowRetentionPolicy configures how long a WfRun is retained in the data store before\nbeing deleted after it is completed or failed."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"seconds_after_wf_termination"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"wf_gc_policy"})]}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Delete all WfRun's X seconds after they terminate, regardless of status."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"workflowevent",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEvent"})]}),"\n",(0,r.jsxs)(s.p,{children:['A WorkflowEvent represents a "Thing That Happened" ',(0,r.jsx)(s.em,{children:"INSIDE"})," a WfRun. It is DIFFERENT from\nan ExternalEvent, because an ExternalEvent represents something that happened OUTSIDE the WfRun,\nand is used to send information to the WfRun."]}),"\n",(0,r.jsx)(s.p,{children:"In contrast, a WorkflowEvent is thrown by the WfRun and is used to send information to the outside\nworld."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventid",children:"WorkflowEventId"})}),(0,r.jsx)(s.td,{children:"The ID of the WorkflowEvent. Contains WfRunId and WorkflowEventDefId."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The content of the WorkflowEvent."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time that the WorkflowEvent was created."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"workfloweventdef",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabletype",children:"VariableType"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsx)(s.h2,{id:"littlehorse-enums",children:"LittleHorse Enums"}),"\n",(0,r.jsx)(s.p,{children:"This section contains the enums defined by the LittleHorse API."}),"\n",(0,r.jsx)(s.h3,{id:"aclaction",children:"Enum ACLAction"}),"\n",(0,r.jsx)(s.p,{children:"Describes an Action that can be taken over a specific set of resources."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"READ"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["Allows all RPC's that start with ",(0,r.jsx)(s.code,{children:"Get"}),", ",(0,r.jsx)(s.code,{children:"List"}),", and ",(0,r.jsx)(s.code,{children:"Search"})," in relation to the metadata (eg. ",(0,r.jsx)(s.code,{children:"TaskDef"})," for ",(0,r.jsx)(s.code,{children:"ACL_TASK"}),") or run data (eg. ",(0,r.jsx)(s.code,{children:"TaskRun"})," for ",(0,r.jsx)(s.code,{children:"ACL_TASK"}),")"]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"RUN"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["Allows RPC's that are needed for mutating the ",(0,r.jsx)(s.em,{children:"runs"})," of the resource. For example, ",(0,r.jsx)(s.code,{children:"RUN"})," over ",(0,r.jsx)(s.code,{children:"ACL_TASK"})," allows the ",(0,r.jsx)(s.code,{children:"ReportTask"})," and ",(0,r.jsx)(s.code,{children:"PollTask"})," RPC's, and ",(0,r.jsx)(s.code,{children:"RUN"})," over ",(0,r.jsx)(s.code,{children:"ACL_WORKFLOW"})," allows the ",(0,r.jsx)(s.code,{children:"RunWf"}),", ",(0,r.jsx)(s.code,{children:"DeleteWfRun"}),", ",(0,r.jsx)(s.code,{children:"StopWfRun"}),", and ",(0,r.jsx)(s.code,{children:"ResumeWfRun"})," RPC's."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"WRITE_METADATA"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsxs)(s.td,{children:["Allows mutating metadata. For example, ",(0,r.jsx)(s.code,{children:"WRITE_METADATA"})," over ",(0,r.jsx)(s.code,{children:"ACL_WORKFLOW"})," allows mutating ",(0,r.jsx)(s.code,{children:"WfSpec"}),"s, and ",(0,r.jsx)(s.code,{children:"WRITE_METADATA"})," over ",(0,r.jsx)(s.code,{children:"ACL_TASK"})," allows mutating ",(0,r.jsx)(s.code,{children:"TaskDef"}),"s."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ALL_ACTIONS"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"Allows all actions related to a resource."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"aclresource",children:"Enum ACLResource"}),"\n",(0,r.jsx)(s.p,{children:"Defines a resource type for ACL's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_WORKFLOW"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["Refers to ",(0,r.jsx)(s.code,{children:"WfSpec"})," and ",(0,r.jsx)(s.code,{children:"WfRun"})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_TASK"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["Refers to ",(0,r.jsx)(s.code,{children:"TaskDef"})," and ",(0,r.jsx)(s.code,{children:"TaskRun"})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_EXTERNAL_EVENT"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsxs)(s.td,{children:["Refers to ",(0,r.jsx)(s.code,{children:"ExternalEventDef"})," and ",(0,r.jsx)(s.code,{children:"ExternalEvent"})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_USER_TASK"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsxs)(s.td,{children:["Refers to ",(0,r.jsx)(s.code,{children:"UserTaskDef"})," and ",(0,r.jsx)(s.code,{children:"UserTaskRun"})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_PRINCIPAL"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsxs)(s.td,{children:["Refers to the ",(0,r.jsx)(s.code,{children:"Principal"})," resource. Currently, the ",(0,r.jsx)(s.code,{children:"ACL_PRINCIPAL"})," permission is only valid in the ",(0,r.jsx)(s.code,{children:"global_acls"})," field of the ",(0,r.jsx)(s.code,{children:"Principal"}),". A ",(0,r.jsx)(s.code,{children:"Principal"})," who only has access to a specific Tenant cannot create othe Principals because a Principal is scoped to the Cluster, and not to a Tenant."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_TENANT"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsxs)(s.td,{children:["Refers to the ",(0,r.jsx)(s.code,{children:"Tenant"})," resource. The ",(0,r.jsx)(s.code,{children:"ACL_TENANT"})," permission is only valid in the ",(0,r.jsx)(s.code,{children:"global_acls"})," field of the ",(0,r.jsx)(s.code,{children:"Principal"}),". This is because the ",(0,r.jsx)(s.code,{children:"Tenant"})," resource is cluster-scoped."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_ALL_RESOURCES"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsxs)(s.td,{children:["Refers to all resources. In the ",(0,r.jsx)(s.code,{children:"global_acls"})," field, this includes ",(0,r.jsx)(s.code,{children:"Principal"})," and ",(0,r.jsx)(s.code,{children:"Tenant"})," resources. In the ",(0,r.jsx)(s.code,{children:"per_tenant_acls"})," field, this does not include ",(0,r.jsx)(s.code,{children:"Principal"})," and ",(0,r.jsx)(s.code,{children:"Tenant"})," since those are cluster-scoped resources."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_TASK_WORKER_GROUP"}),(0,r.jsx)(s.td,{children:"7"}),(0,r.jsxs)(s.td,{children:["Refers to the ",(0,r.jsx)(s.code,{children:"TaskWorkerGroup"})," associated with a TaskDef"]})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"lherrortype",children:"Enum LHErrorType"}),"\n",(0,r.jsx)(s.p,{children:"This enum is all of the types of technical failure that can occur in a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"CHILD_FAILURE"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"A child ThreadRun failed with a technical ERROR."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"VAR_SUB_ERROR"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"Failed substituting input variables into a NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"VAR_MUTATION_ERROR"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"Failed mutating variables after a NodeRun successfully completed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"USER_TASK_CANCELLED"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"A UserTaskRun was cancelled (EVOLVING: this will become a Business EXCEPTION)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TIMEOUT"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"A NodeRun failed due to a timeout."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_FAILURE"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsx)(s.td,{children:"A TaskRun failed due to an unexpected error."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"VAR_ERROR"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsx)(s.td,{children:"Wrapper for VAR_SUB_ERROR and VAR_MUTATION_ERROR"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_ERROR"}),(0,r.jsx)(s.td,{children:"7"}),(0,r.jsx)(s.td,{children:"Wrapper for TASK_FALIURE and TIMEOUT"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"INTERNAL_ERROR"}),(0,r.jsx)(s.td,{children:"8"}),(0,r.jsx)(s.td,{children:"An unexpected LittleHorse Internal error occurred. This is not expected to happen."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"lhstatus",children:"Enum LHStatus"}),"\n",(0,r.jsx)(s.p,{children:"Status used for WfRun, ThreadRun, and NodeRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"STARTING"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"The entity is starting."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"RUNNING"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"The entity is running."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"COMPLETED"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"The entity is completed. This is a terminal state."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HALTING"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsxs)(s.td,{children:["The entity will move to ",(0,r.jsx)(s.code,{children:"HALTED"})," as soon as all preconditions for halting are satisfied."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HALTED"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"The entity is halted, either by user intervention or by the workflow scheduler."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ERROR"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsx)(s.td,{children:"The entity has failed due to a technical failure, such as a type conversion error, a task timeout due to network failure, or a task worker crash."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"EXCEPTION"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsx)(s.td,{children:"The entity has failed due to a business exception defined by the user."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"metadatastatus",children:"Enum MetadataStatus"}),"\n",(0,r.jsx)(s.p,{children:"Status of a Metadata Object, such as WfSpec or TaskDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACTIVE"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"ACTIVE means the object can be used."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ARCHIVED"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"An ARCHIVED WfSpec can no longer be used to create new WfRun's, but existing WfRun's will be allowed to run to completion."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TERMINATING"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"A TERMINATING WfSpec is actively deleting all running WfRun's, and will self-destruct once all of its child WfRun's are terminated."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"metricswindowlength",children:"Enum MetricsWindowLength"}),"\n",(0,r.jsx)(s.p,{children:"Metrics"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"MINUTES_5"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HOURS_2"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"DAYS_1"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"taskstatus",children:"Enum TaskStatus"}),"\n",(0,r.jsx)(s.p,{children:"Status of a TaskRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_SCHEDULED"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"Scheduled in the Task Queue but not yet picked up by a Task Worker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_RUNNING"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"Picked up by a Task Worker, but not yet reported or timed out."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_SUCCESS"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"Successfully completed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_FAILED"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"Task Worker reported a technical failure while attempting to execute the TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_TIMEOUT"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"Task Worker did not report a result in time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_OUTPUT_SERIALIZING_ERROR"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsx)(s.td,{children:"Task Worker reported that it was unable to serialize the output of the TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_INPUT_VAR_SUB_ERROR"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsx)(s.td,{children:"Task Worker was unable to deserialize the input variables into appropriate language-specific objects to pass into the Task Function"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_EXCEPTION"}),(0,r.jsx)(s.td,{children:"8"}),(0,r.jsx)(s.td,{children:"Task Function business logic determined that there was a business exception."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_PENDING"}),(0,r.jsx)(s.td,{children:"9"}),(0,r.jsx)(s.td,{children:'Refers to a TaskAttempt that is not yet scheduled. This happens when using retries with an ExponentialBackoffRetryPolicy: the TaskAttempt isn\'t supposed to be scheduled until it "matures", but it does already exist.'})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"variabletype",children:"Enum VariableType"}),"\n",(0,r.jsx)(s.p,{children:"Type of a Varaible in LittleHorse. Corresponds to the possible value type's of a\nVariableValue."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"JSON_OBJ"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["An object represented as a json string. ",(0,r.jsx)("br",{})]})]})})]}),"\n",(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"JSON_OBJ"})," variable allows you to store complex objects in the JSON format. When using the Java and GoLang SDK's, the ",(0,r.jsx)(s.code,{children:"JSON_OBJ"})," variable type is often used transparently to the user. For example, the Java Task Worker SDK can inspect your method signature and automatically deserialize an input variable into a POJO. |\n| JSON_ARR | 1 | The ",(0,r.jsx)(s.code,{children:"JSON_ARR"})," variable allows you to store collections of objects as a JSON array. The behavior is similar to the ",(0,r.jsx)(s.code,{children:"JSON_OBJ"})," variable type. |\n| DOUBLE | 2 | The ",(0,r.jsx)(s.code,{children:"DOUBLE"})," variable type is a 64-bit floating point number. It can be cast to an ",(0,r.jsx)(s.code,{children:"INT"}),". |\n| BOOL | 3 | Boolean denotes a simple boolean switch. |\n| STR | 4 | The ",(0,r.jsx)(s.code,{children:"STR"})," variable type is stored as a String. ",(0,r.jsx)(s.code,{children:"INT"}),", ",(0,r.jsx)(s.code,{children:"DOUBLE"}),", and ",(0,r.jsx)(s.code,{children:"BOOL"})," variables can be cast to a ",(0,r.jsx)(s.code,{children:"STR"}),". |\n| INT | 5 | The ",(0,r.jsx)(s.code,{children:"INT"})," variable type is stored as a 64-bit integer. The ",(0,r.jsx)(s.code,{children:"INT"})," can be cast to a ",(0,r.jsx)(s.code,{children:"DOUBLE"}),". |\n| BYTES | 6 | The ",(0,r.jsx)(s.code,{children:"BYTES"})," variable type allows you to store an arbitrary byte string. |"]}),"\n",(0,r.jsx)(s.h3,{id:"comparator",children:"Enum Comparator"}),"\n",(0,r.jsx)(s.p,{children:"Operator for comparing two values to create a boolean expression."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"LESS_THAN"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["Equivalent to ",(0,r.jsx)(s.code,{children:"<"}),". Only valid for primitive types (no JSON_OBJ or JSON_ARR)."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"GREATER_THAN"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["Equivalent to ",(0,r.jsx)(s.code,{children:">"}),". Only valid for primitive types (no JSON_OBJ or JSON_ARR)."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"LESS_THAN_EQ"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsxs)(s.td,{children:["Equivalent to ",(0,r.jsx)(s.code,{children:"<="}),". Only valid for primitive types (no JSON_OBJ or JSON_ARR)."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"GREATER_THAN_EQ"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsxs)(s.td,{children:["Equivalent to ",(0,r.jsx)(s.code,{children:">="}),". Only valid for primitive types (no JSON_OBJ or JSON_ARR)."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"EQUALS"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"This is valid for any variable type, and is similar to .equals() in Java."})]})]})]}),"\n",(0,r.jsxs)(s.p,{children:["One note: if the RHS is a different type from the LHS, then LittleHorse will try to cast the RHS to the same type as the LHS. If the cast fails, then the ThreadRun fails with a VAR_SUB_ERROR. |\n| NOT_EQUALS | 5 | This is the inverse of ",(0,r.jsx)(s.code,{children:"EQUALS"})," |\n| IN | 6 | Only valid if the RHS is a JSON_OBJ or JSON_ARR. Valid for any type on the LHS."]}),"\n",(0,r.jsxs)(s.p,{children:["For the JSON_OBJ type, this returns true if the LHS is equal to a ",(0,r.jsx)(s.em,{children:"KEY"})," in the RHS. For the JSON_ARR type, it returns true if one of the elements of the RHS is equal to the LHS. |\n| NOT_IN | 7 | The inverse of IN. |"]}),"\n",(0,r.jsx)(s.h3,{id:"utactiontriggeruthook",children:"Enum UTActionTrigger.UTHook"}),"\n",(0,r.jsx)(s.p,{children:"Enumerates the different lifecycle hooks that can cause the timer to start running."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ON_ARRIVAL"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["The hook should be scheduled ",(0,r.jsx)(s.code,{children:"delay_seconds"})," after the UserTaskRun is created. This hook only causes the action to be scheduled once."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ON_TASK_ASSIGNED"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["The hook should be scheduled ",(0,r.jsx)(s.code,{children:"delay_seconds"}),' after the ownership of the UserTaskRun changes. This hook causes the Action to be scheduled one or more times. The first time is scheduled when the UserTaskRun is created, since we treat the change from "UserTaskRun is nonexistent" to "UserTaskRun is owned by a userId or userGroup" as a change in ownership.']})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"variablemutationtype",children:"Enum VariableMutationType"}),"\n",(0,r.jsx)(s.p,{children:"Enumerates the available operations to mutate a variable in a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ASSIGN"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"Set the variable specified by the LHS to the value of the RHS."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ADD"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"Add the RHS to the LHS."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"EXTEND"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"Append the RHS to the LHS (valid if the LHS is a STR or JSON_ARR)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"SUBTRACT"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"Subtract the RHS from the LHS (both must be INT or DOUBLE)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"MULTIPLY"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"Multiply the LHS by the RHS (both must be INT or DOUBLE)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"DIVIDE"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsx)(s.td,{children:"Divide the LHS by the RHS (both must be INT or DOUBLE)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"REMOVE_IF_PRESENT"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsx)(s.td,{children:"Remove any occurrences of RHS from LHS (LHS must be JSON_ARR)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"REMOVE_INDEX"}),(0,r.jsx)(s.td,{children:"7"}),(0,r.jsx)(s.td,{children:"Remove item at index RHS from LHS (LHS must be JSON_ARR)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"REMOVE_KEY"}),(0,r.jsx)(s.td,{children:"8"}),(0,r.jsx)(s.td,{children:"Remove the key specified by RHS from the LHS (LHS must be JSON_OBJ)"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"waitforthreadsrunwaitingthreadstatus",children:"Enum WaitForThreadsRun.WaitingThreadStatus"}),"\n",(0,r.jsx)(s.p,{children:"The status of a single ThreadRun that we are waiting for."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"THREAD_IN_PROGRESS"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"The ThreadRun is in progress (i.e. not COMPLETED nor EXCEPTION nor ERROR)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"THREAD_HANDLING_FAILURE"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"The ThreadRun failed with some failure, and the FailureHandler is running for that Failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"THREAD_COMPLETED_OR_FAILURE_HANDLED"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:'We can mark this ThreadRun as "already waited for", meaning that either: 1. It completed successfully, OR 2. It failed, and the Failure Handler successfully completed'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"THREAD_UNSUCCESSFUL"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"The ThreadRun did not complete successfully, and there wasn't a successful run of a Failure Handler for the Failure that was thrown."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"allowedupdatetype",children:"Enum AllowedUpdateType"}),"\n",(0,r.jsx)(s.p,{children:"This enum controls the behavior of a PutWfSpecRequest when a WfSpec with the same\nname previously exists."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ALL_UPDATES"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"Allows any update: both minor (revsion) changes and breaking (majorVersion) changes are accepted"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"MINOR_REVISION_UPDATES"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"Allows only backwards-compatible changes that do not change the required input variables or the searchable variables in the WfSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"NO_UPDATES"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"Rejects any changes to the WfSpec."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"searchnoderunrequestnodetype",children:"Enum SearchNodeRunRequest.NodeType"}),"\n",(0,r.jsx)(s.p,{children:"This enum denotes the type of a NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"TASK node schedules a TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"EXTERNAL_EVENT"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"EXTERNAL_EVENT blocks the ThreadRun until a specified ExternalEvent arrives"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ENTRYPOINT"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"ENTRYPOINT kicks off a ThreadRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"EXIT"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"EXIT completes a ThreadRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"START_THREAD"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"START_THREAD creates a Child ThreadRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"WAIT_THREADS"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsx)(s.td,{children:"WAIT_THREADS waits for one or more child ThreadRuns to complete"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"SLEEP"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsx)(s.td,{children:"SLEEP makes the ThreadRun sleep for a specified time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"USER_TASK"}),(0,r.jsx)(s.td,{children:"7"}),(0,r.jsx)(s.td,{children:"USER_TASK creates a UserTaskRun and blocks until the UserTaskRun is completed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"START_MULTIPLE_THREADS"}),(0,r.jsx)(s.td,{children:"8"}),(0,r.jsx)(s.td,{children:"START_MULTIPLE_THREADS iterates over a list and starts a Child Thread for each item"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"saveusertaskrunprogressrequestsaveusertaskrunassignmentpolicy",children:"Enum SaveUserTaskRunProgressRequest.SaveUserTaskRunAssignmentPolicy"}),"\n",(0,r.jsxs)(s.p,{children:["Configures how to handle ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," ownership when saving it."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"FAIL_IF_CLAIMED_BY_OTHER"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"If the UserTaskRun is already assigned to a user_id, then the request throws a FAILED_PRECONDITION error."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"IGNORE_CLAIM"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["If the UserTaskRun is already assigned to a user_id, then the request will leave the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," assigned to the current user but still update the ",(0,r.jsx)(s.code,{children:"results"})," and log in the ",(0,r.jsx)(s.code,{children:"events"})," who updated the results."]})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"usertaskrunstatus",children:"Enum UserTaskRunStatus"}),"\n",(0,r.jsx)(s.p,{children:"The status that a UserTaskRun can be in."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"UNASSIGNED"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"Not assigned to a specific user yet."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ASSIGNED"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"Assigned to a specific user, but not completed or cancelled yet."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"DONE"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"Done."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"CANCELLED"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"Cancelled."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"threadtype",children:"Enum ThreadType"}),"\n",(0,r.jsx)(s.p,{children:"The type of a ThreadRUn."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ENTRYPOINT"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"The ENTRYPOINT ThreadRun. Exactly one per WfRun. Always has number == 0."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"CHILD"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"A ThreadRun explicitly created by another ThreadRun via a START_THREAD or START_MULTIPLE_THREADS NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"INTERRUPT"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"A ThreadRun that was created to handle an Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"FAILURE_HANDLER"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"A ThreadRun that was created to handle a Failure."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"failurehandlerdeflhfailuretype",children:"Enum FailureHandlerDef.LHFailureType"}),"\n",(0,r.jsx)(s.p,{children:"Specifies a type of Failure"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"FAILURE_TYPE_ERROR"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["FAILURE_TYPE_ERROR specifies any technical ",(0,r.jsx)(s.code,{children:"ERROR"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"FAILURE_TYPE_EXCEPTION"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["Specifies a user-defined, business-related ",(0,r.jsx)(s.code,{children:"EXCEPTION"}),"."]})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"wfrunvariableaccesslevel",children:"Enum WfRunVariableAccessLevel"}),"\n",(0,r.jsx)(s.p,{children:"Determines the Access Level for a Variable in a ThreadSpec/WfSpec."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"PUBLIC_VAR"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["A ",(0,r.jsx)(s.code,{children:"PUBLIC_VAR"})," can be accessed (read + mutated) by child ",(0,r.jsx)(s.code,{children:"WfRun"}),"'s."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"PRIVATE_VAR"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["A ",(0,r.jsx)(s.code,{children:"PRIVATE_VAR"})," cannot be accessed by a child ",(0,r.jsx)(s.code,{children:"WfRun"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"INHERITED_VAR"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsxs)(s.td,{children:["An ",(0,r.jsx)(s.code,{children:"INHERITED_VAR"})," is inherited from the parent ",(0,r.jsx)(s.code,{children:"WfRun"}),". Only valid in a ",(0,r.jsx)(s.code,{children:"WfSpec"})," that has a parent. Also can only be declared in the Entrypoint Thread."]})]})]})]})]})}function x(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,s,d)=>{d.d(s,{R:()=>i,x:()=>h});var r=d(6540);const n={},t=r.createContext(n);function i(e){const s=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function h(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),r.createElement(t.Provider,{value:s},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/2a162317.e3b8f6cf.js b/assets/js/2a162317.e3b8f6cf.js
new file mode 100644
index 000000000..d1d3a7b90
--- /dev/null
+++ b/assets/js/2a162317.e3b8f6cf.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunklh_site=self.webpackChunklh_site||[]).push([[7828],{4620:(e,s,d)=>{d.r(s),d.d(s,{assets:()=>l,contentTitle:()=>i,default:()=>x,frontMatter:()=>t,metadata:()=>h,toc:()=>c});var r=d(4848),n=d(8453);const t={},i="LittleHorse API Reference",h={id:"api",title:"LittleHorse API Reference",description:"The LittleHorse Server exposes a GRPC API to its clients. For most general usage of LittleHorse, you will not need to",source:"@site/docs/08-api.md",sourceDirName:".",slug:"/api",permalink:"/docs/api",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:8,frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Tips, Pointers, and FAQ",permalink:"/docs/faq"}},l={},c=[{value:"LittleHorse GRPC API",id:"littlehorse-grpc-api",level:2},{value:"RPC PutTaskDef",id:"puttaskdef",level:3},{value:"RPC GetTaskDef",id:"gettaskdef",level:3},{value:"RPC GetTaskWorkerGroup",id:"gettaskworkergroup",level:3},{value:"RPC PutExternalEventDef",id:"putexternaleventdef",level:3},{value:"RPC GetExternalEventDef",id:"getexternaleventdef",level:3},{value:"RPC PutWorkflowEventDef",id:"putworkfloweventdef",level:3},{value:"RPC PutWfSpec",id:"putwfspec",level:3},{value:"RPC GetWfSpec",id:"getwfspec",level:3},{value:"RPC GetLatestWfSpec",id:"getlatestwfspec",level:3},{value:"RPC MigrateWfSpec",id:"migratewfspec",level:3},{value:"RPC PutUserTaskDef",id:"putusertaskdef",level:3},{value:"RPC GetUserTaskDef",id:"getusertaskdef",level:3},{value:"RPC GetLatestUserTaskDef",id:"getlatestusertaskdef",level:3},{value:"RPC RunWf",id:"runwf",level:3},{value:"RPC ScheduleWf",id:"schedulewf",level:3},{value:"RPC SearchScheduledWfRun",id:"searchscheduledwfrun",level:3},{value:"RPC GetScheduledWfRun",id:"getscheduledwfrun",level:3},{value:"RPC GetWfRun",id:"getwfrun",level:3},{value:"RPC GetUserTaskRun",id:"getusertaskrun",level:3},{value:"RPC AssignUserTaskRun",id:"assignusertaskrun",level:3},{value:"RPC CompleteUserTaskRun",id:"completeusertaskrun",level:3},{value:"RPC CancelUserTaskRun",id:"cancelusertaskrun",level:3},{value:"RPC SaveUserTaskRunProgress",id:"saveusertaskrunprogress",level:3},{value:"RPC ListUserTaskRuns",id:"listusertaskruns",level:3},{value:"RPC GetNodeRun",id:"getnoderun",level:3},{value:"RPC ListNodeRuns",id:"listnoderuns",level:3},{value:"RPC GetTaskRun",id:"gettaskrun",level:3},{value:"RPC ListTaskRuns",id:"listtaskruns",level:3},{value:"RPC GetVariable",id:"getvariable",level:3},{value:"RPC ListVariables",id:"listvariables",level:3},{value:"RPC PutExternalEvent",id:"putexternalevent",level:3},{value:"RPC GetExternalEvent",id:"getexternalevent",level:3},{value:"RPC AwaitWorkflowEvent",id:"awaitworkflowevent",level:3},{value:"RPC GetWorkflowEventDef",id:"getworkfloweventdef",level:3},{value:"RPC GetWorkflowEvent",id:"getworkflowevent",level:3},{value:"RPC ListExternalEvents",id:"listexternalevents",level:3},{value:"RPC ListWorkflowEvents",id:"listworkflowevents",level:3},{value:"RPC SearchWfRun",id:"searchwfrun",level:3},{value:"RPC SearchNodeRun",id:"searchnoderun",level:3},{value:"RPC SearchTaskRun",id:"searchtaskrun",level:3},{value:"RPC SearchUserTaskRun",id:"searchusertaskrun",level:3},{value:"RPC SearchVariable",id:"searchvariable",level:3},{value:"RPC SearchExternalEvent",id:"searchexternalevent",level:3},{value:"RPC SearchWorkflowEvent",id:"searchworkflowevent",level:3},{value:"RPC SearchTaskDef",id:"searchtaskdef",level:3},{value:"RPC SearchUserTaskDef",id:"searchusertaskdef",level:3},{value:"RPC SearchWfSpec",id:"searchwfspec",level:3},{value:"RPC SearchExternalEventDef",id:"searchexternaleventdef",level:3},{value:"RPC SearchWorkflowEventDef",id:"searchworkfloweventdef",level:3},{value:"RPC SearchTenant",id:"searchtenant",level:3},{value:"RPC SearchPrincipal",id:"searchprincipal",level:3},{value:"RPC RegisterTaskWorker",id:"registertaskworker",level:3},{value:"RPC PollTask",id:"polltask",level:3},{value:"RPC ReportTask",id:"reporttask",level:3},{value:"RPC StopWfRun",id:"stopwfrun",level:3},{value:"RPC ResumeWfRun",id:"resumewfrun",level:3},{value:"RPC RescueThreadRun",id:"rescuethreadrun",level:3},{value:"RPC DeleteWfRun",id:"deletewfrun",level:3},{value:"RPC DeleteTaskDef",id:"deletetaskdef",level:3},{value:"RPC DeleteWfSpec",id:"deletewfspec",level:3},{value:"RPC DeleteUserTaskDef",id:"deleteusertaskdef",level:3},{value:"RPC DeleteExternalEventDef",id:"deleteexternaleventdef",level:3},{value:"RPC DeleteWorkflowEventDef",id:"deleteworkfloweventdef",level:3},{value:"RPC DeletePrincipal",id:"deleteprincipal",level:3},{value:"RPC DeleteScheduledWfRun",id:"deletescheduledwfrun",level:3},{value:"RPC GetTaskDefMetricsWindow",id:"gettaskdefmetricswindow",level:3},{value:"RPC GetWfSpecMetricsWindow",id:"getwfspecmetricswindow",level:3},{value:"RPC ListTaskDefMetrics",id:"listtaskdefmetrics",level:3},{value:"RPC ListWfSpecMetrics",id:"listwfspecmetrics",level:3},{value:"RPC PutTenant",id:"puttenant",level:3},{value:"RPC GetTenant",id:"gettenant",level:3},{value:"RPC PutPrincipal",id:"putprincipal",level:3},{value:"RPC Whoami",id:"whoami",level:3},{value:"RPC GetServerVersion",id:"getserverversion",level:3},{value:"LittleHorse Protobuf Schemas",id:"littlehorse-protobuf-schemas",level:2},{value:"Message DeletePrincipalRequest",id:"deleteprincipalrequest",level:3},{value:"Message Principal",id:"principal",level:3},{value:"Message Principal.PerTenantAclsEntry",id:"principalpertenantaclsentry",level:3},{value:"Message PutPrincipalRequest",id:"putprincipalrequest",level:3},{value:"Message PutPrincipalRequest.PerTenantAclsEntry",id:"putprincipalrequestpertenantaclsentry",level:3},{value:"Message PutTenantRequest",id:"puttenantrequest",level:3},{value:"Message ServerACL",id:"serveracl",level:3},{value:"Message ServerACLs",id:"serveracls",level:3},{value:"Message Tenant",id:"tenant",level:3},{value:"Message ExponentialBackoffRetryPolicy",id:"exponentialbackoffretrypolicy",level:3},{value:"Message TaskNode",id:"tasknode",level:3},{value:"Message UTActionTrigger",id:"utactiontrigger",level:3},{value:"Message UTActionTrigger.UTACancel",id:"utactiontriggerutacancel",level:3},{value:"Message UTActionTrigger.UTAReassign",id:"utactiontriggerutareassign",level:3},{value:"Message UTActionTrigger.UTATask",id:"utactiontriggerutatask",level:3},{value:"Message VariableAssignment",id:"variableassignment",level:3},{value:"Message VariableAssignment.FormatString",id:"variableassignmentformatstring",level:3},{value:"Message VariableDef",id:"variabledef",level:3},{value:"Message VariableMutation",id:"variablemutation",level:3},{value:"Message VariableMutation.NodeOutputSource",id:"variablemutationnodeoutputsource",level:3},{value:"Message ExternalEvent",id:"externalevent",level:3},{value:"Message ExternalEventDef",id:"externaleventdef",level:3},{value:"Message ExternalEventRetentionPolicy",id:"externaleventretentionpolicy",level:3},{value:"Message EntrypointRun",id:"entrypointrun",level:3},{value:"Message ExitRun",id:"exitrun",level:3},{value:"Message ExternalEventNodeRun",id:"externaleventnoderun",level:3},{value:"Message Failure",id:"failure",level:3},{value:"Message NodeRun",id:"noderun",level:3},{value:"Message SleepNodeRun",id:"sleepnoderun",level:3},{value:"Message StartMultipleThreadsRun",id:"startmultiplethreadsrun",level:3},{value:"Message StartThreadRun",id:"startthreadrun",level:3},{value:"Message TaskNodeRun",id:"tasknoderun",level:3},{value:"Message ThrowEventNodeRun",id:"throweventnoderun",level:3},{value:"Message UserTaskNodeRun",id:"usertasknoderun",level:3},{value:"Message WaitForConditionRun",id:"waitforconditionrun",level:3},{value:"Message WaitForThreadsRun",id:"waitforthreadsrun",level:3},{value:"Message WaitForThreadsRun.WaitForThread",id:"waitforthreadsrunwaitforthread",level:3},{value:"Message ExternalEventDefId",id:"externaleventdefid",level:3},{value:"Message ExternalEventId",id:"externaleventid",level:3},{value:"Message NodeRunId",id:"noderunid",level:3},{value:"Message PrincipalId",id:"principalid",level:3},{value:"Message ScheduledWfRunId",id:"scheduledwfrunid",level:3},{value:"Message TaskDefId",id:"taskdefid",level:3},{value:"Message TaskDefMetricsId",id:"taskdefmetricsid",level:3},{value:"Message TaskRunId",id:"taskrunid",level:3},{value:"Message TaskWorkerGroupId",id:"taskworkergroupid",level:3},{value:"Message TenantId",id:"tenantid",level:3},{value:"Message UserTaskDefId",id:"usertaskdefid",level:3},{value:"Message UserTaskRunId",id:"usertaskrunid",level:3},{value:"Message VariableId",id:"variableid",level:3},{value:"Message WfRunId",id:"wfrunid",level:3},{value:"Message WfSpecId",id:"wfspecid",level:3},{value:"Message WfSpecMetricsId",id:"wfspecmetricsid",level:3},{value:"Message WorkflowEventDefId",id:"workfloweventdefid",level:3},{value:"Message WorkflowEventId",id:"workfloweventid",level:3},{value:"Message ScheduledWfRun",id:"scheduledwfrun",level:3},{value:"Message ScheduledWfRun.VariablesEntry",id:"scheduledwfrunvariablesentry",level:3},{value:"Message AwaitWorkflowEventRequest",id:"awaitworkfloweventrequest",level:3},{value:"Message DeleteExternalEventDefRequest",id:"deleteexternaleventdefrequest",level:3},{value:"Message DeleteExternalEventRequest",id:"deleteexternaleventrequest",level:3},{value:"Message DeleteScheduledWfRunRequest",id:"deletescheduledwfrunrequest",level:3},{value:"Message DeleteTaskDefRequest",id:"deletetaskdefrequest",level:3},{value:"Message DeleteUserTaskDefRequest",id:"deleteusertaskdefrequest",level:3},{value:"Message DeleteWfRunRequest",id:"deletewfrunrequest",level:3},{value:"Message DeleteWfSpecRequest",id:"deletewfspecrequest",level:3},{value:"Message DeleteWorkflowEventDefRequest",id:"deleteworkfloweventdefrequest",level:3},{value:"Message ExternalEventDefIdList",id:"externaleventdefidlist",level:3},{value:"Message ExternalEventIdList",id:"externaleventidlist",level:3},{value:"Message ExternalEventList",id:"externaleventlist",level:3},{value:"Message GetLatestUserTaskDefRequest",id:"getlatestusertaskdefrequest",level:3},{value:"Message GetLatestWfSpecRequest",id:"getlatestwfspecrequest",level:3},{value:"Message LHHostInfo",id:"lhhostinfo",level:3},{value:"Message ListExternalEventsRequest",id:"listexternaleventsrequest",level:3},{value:"Message ListNodeRunsRequest",id:"listnoderunsrequest",level:3},{value:"Message ListTaskMetricsRequest",id:"listtaskmetricsrequest",level:3},{value:"Message ListTaskMetricsResponse",id:"listtaskmetricsresponse",level:3},{value:"Message ListTaskRunsRequest",id:"listtaskrunsrequest",level:3},{value:"Message ListUserTaskRunRequest",id:"listusertaskrunrequest",level:3},{value:"Message ListVariablesRequest",id:"listvariablesrequest",level:3},{value:"Message ListWfMetricsRequest",id:"listwfmetricsrequest",level:3},{value:"Message ListWfMetricsResponse",id:"listwfmetricsresponse",level:3},{value:"Message ListWorkflowEventsRequest",id:"listworkfloweventsrequest",level:3},{value:"Message MigrateWfSpecRequest",id:"migratewfspecrequest",level:3},{value:"Message NodeRunIdList",id:"noderunidlist",level:3},{value:"Message NodeRunList",id:"noderunlist",level:3},{value:"Message PollTaskRequest",id:"polltaskrequest",level:3},{value:"Message PollTaskResponse",id:"polltaskresponse",level:3},{value:"Message PrincipalIdList",id:"principalidlist",level:3},{value:"Message PutExternalEventDefRequest",id:"putexternaleventdefrequest",level:3},{value:"Message PutExternalEventRequest",id:"putexternaleventrequest",level:3},{value:"Message PutTaskDefRequest",id:"puttaskdefrequest",level:3},{value:"Message PutUserTaskDefRequest",id:"putusertaskdefrequest",level:3},{value:"Message PutWfSpecRequest",id:"putwfspecrequest",level:3},{value:"Message PutWfSpecRequest.ThreadSpecsEntry",id:"putwfspecrequestthreadspecsentry",level:3},{value:"Message PutWorkflowEventDefRequest",id:"putworkfloweventdefrequest",level:3},{value:"Message RegisterTaskWorkerRequest",id:"registertaskworkerrequest",level:3},{value:"Message RegisterTaskWorkerResponse",id:"registertaskworkerresponse",level:3},{value:"Message ReportTaskRun",id:"reporttaskrun",level:3},{value:"Message RescueThreadRunRequest",id:"rescuethreadrunrequest",level:3},{value:"Message ResumeWfRunRequest",id:"resumewfrunrequest",level:3},{value:"Message RunWfRequest",id:"runwfrequest",level:3},{value:"Message RunWfRequest.VariablesEntry",id:"runwfrequestvariablesentry",level:3},{value:"Message ScheduleWfRequest",id:"schedulewfrequest",level:3},{value:"Message ScheduleWfRequest.VariablesEntry",id:"schedulewfrequestvariablesentry",level:3},{value:"Message ScheduledTask",id:"scheduledtask",level:3},{value:"Message ScheduledWfRunIdList",id:"scheduledwfrunidlist",level:3},{value:"Message SearchExternalEventDefRequest",id:"searchexternaleventdefrequest",level:3},{value:"Message SearchExternalEventRequest",id:"searchexternaleventrequest",level:3},{value:"Message SearchNodeRunRequest",id:"searchnoderunrequest",level:3},{value:"Message SearchPrincipalRequest",id:"searchprincipalrequest",level:3},{value:"Message SearchScheduledWfRunRequest",id:"searchscheduledwfrunrequest",level:3},{value:"Message SearchTaskDefRequest",id:"searchtaskdefrequest",level:3},{value:"Message SearchTaskRunRequest",id:"searchtaskrunrequest",level:3},{value:"Message SearchTenantRequest",id:"searchtenantrequest",level:3},{value:"Message SearchUserTaskDefRequest",id:"searchusertaskdefrequest",level:3},{value:"Message SearchUserTaskRunRequest",id:"searchusertaskrunrequest",level:3},{value:"Message SearchVariableRequest",id:"searchvariablerequest",level:3},{value:"Message SearchWfRunRequest",id:"searchwfrunrequest",level:3},{value:"Message SearchWfSpecRequest",id:"searchwfspecrequest",level:3},{value:"Message SearchWorkflowEventDefRequest",id:"searchworkfloweventdefrequest",level:3},{value:"Message SearchWorkflowEventRequest",id:"searchworkfloweventrequest",level:3},{value:"Message ServerVersionResponse",id:"serverversionresponse",level:3},{value:"Message StopWfRunRequest",id:"stopwfrunrequest",level:3},{value:"Message TaskDefIdList",id:"taskdefidlist",level:3},{value:"Message TaskDefMetrics",id:"taskdefmetrics",level:3},{value:"Message TaskDefMetricsQueryRequest",id:"taskdefmetricsqueryrequest",level:3},{value:"Message TaskRunIdList",id:"taskrunidlist",level:3},{value:"Message TaskRunList",id:"taskrunlist",level:3},{value:"Message TaskWorkerGroup",id:"taskworkergroup",level:3},{value:"Message TaskWorkerGroup.TaskWorkersEntry",id:"taskworkergrouptaskworkersentry",level:3},{value:"Message TaskWorkerHeartBeatRequest",id:"taskworkerheartbeatrequest",level:3},{value:"Message TaskWorkerMetadata",id:"taskworkermetadata",level:3},{value:"Message TenantIdList",id:"tenantidlist",level:3},{value:"Message UserTaskDefIdList",id:"usertaskdefidlist",level:3},{value:"Message UserTaskRunIdList",id:"usertaskrunidlist",level:3},{value:"Message UserTaskRunList",id:"usertaskrunlist",level:3},{value:"Message VariableIdList",id:"variableidlist",level:3},{value:"Message VariableList",id:"variablelist",level:3},{value:"Message VariableMatch",id:"variablematch",level:3},{value:"Message WfRunIdList",id:"wfrunidlist",level:3},{value:"Message WfSpecIdList",id:"wfspecidlist",level:3},{value:"Message WfSpecMetrics",id:"wfspecmetrics",level:3},{value:"Message WfSpecMetricsQueryRequest",id:"wfspecmetricsqueryrequest",level:3},{value:"Message WorkflowEventDefIdList",id:"workfloweventdefidlist",level:3},{value:"Message WorkflowEventIdList",id:"workfloweventidlist",level:3},{value:"Message WorkflowEventList",id:"workfloweventlist",level:3},{value:"Message TaskDef",id:"taskdef",level:3},{value:"Message TaskDefOutputSchema",id:"taskdefoutputschema",level:3},{value:"Message LHTaskError",id:"lhtaskerror",level:3},{value:"Message LHTaskException",id:"lhtaskexception",level:3},{value:"Message TaskAttempt",id:"taskattempt",level:3},{value:"Message TaskNodeReference",id:"tasknodereference",level:3},{value:"Message TaskRun",id:"taskrun",level:3},{value:"Message TaskRunSource",id:"taskrunsource",level:3},{value:"Message VarNameAndVal",id:"varnameandval",level:3},{value:"Message AssignUserTaskRunRequest",id:"assignusertaskrunrequest",level:3},{value:"Message CancelUserTaskRunRequest",id:"cancelusertaskrunrequest",level:3},{value:"Message CompleteUserTaskRunRequest",id:"completeusertaskrunrequest",level:3},{value:"Message CompleteUserTaskRunRequest.ResultsEntry",id:"completeusertaskrunrequestresultsentry",level:3},{value:"Message SaveUserTaskRunProgressRequest",id:"saveusertaskrunprogressrequest",level:3},{value:"Message SaveUserTaskRunProgressRequest.ResultsEntry",id:"saveusertaskrunprogressrequestresultsentry",level:3},{value:"Message UserTaskDef",id:"usertaskdef",level:3},{value:"Message UserTaskEvent",id:"usertaskevent",level:3},{value:"Message UserTaskEvent.UTEAssigned",id:"usertaskeventuteassigned",level:3},{value:"Message UserTaskEvent.UTECancelled",id:"usertaskeventutecancelled",level:3},{value:"Message UserTaskEvent.UTESaved",id:"usertaskeventutesaved",level:3},{value:"Message UserTaskEvent.UTESaved.ResultsEntry",id:"usertaskeventutesavedresultsentry",level:3},{value:"Message UserTaskEvent.UTETaskExecuted",id:"usertaskeventutetaskexecuted",level:3},{value:"Message UserTaskField",id:"usertaskfield",level:3},{value:"Message UserTaskRun",id:"usertaskrun",level:3},{value:"Message UserTaskRun.ResultsEntry",id:"usertaskrunresultsentry",level:3},{value:"Message UserTaskTriggerReference",id:"usertasktriggerreference",level:3},{value:"Message Variable",id:"variable",level:3},{value:"Message VariableValue",id:"variablevalue",level:3},{value:"Message FailureBeingHandled",id:"failurebeinghandled",level:3},{value:"Message HandlingFailureHaltReason",id:"handlingfailurehaltreason",level:3},{value:"Message Interrupted",id:"interrupted",level:3},{value:"Message ManualHalt",id:"manualhalt",level:3},{value:"Message ParentHalted",id:"parenthalted",level:3},{value:"Message PendingFailureHandler",id:"pendingfailurehandler",level:3},{value:"Message PendingFailureHandlerHaltReason",id:"pendingfailurehandlerhaltreason",level:3},{value:"Message PendingInterrupt",id:"pendinginterrupt",level:3},{value:"Message PendingInterruptHaltReason",id:"pendinginterrupthaltreason",level:3},{value:"Message ThreadHaltReason",id:"threadhaltreason",level:3},{value:"Message ThreadRun",id:"threadrun",level:3},{value:"Message WfRun",id:"wfrun",level:3},{value:"Message Edge",id:"edge",level:3},{value:"Message EdgeCondition",id:"edgecondition",level:3},{value:"Message EntrypointNode",id:"entrypointnode",level:3},{value:"Message ExitNode",id:"exitnode",level:3},{value:"Message ExternalEventNode",id:"externaleventnode",level:3},{value:"Message FailureDef",id:"failuredef",level:3},{value:"Message FailureHandlerDef",id:"failurehandlerdef",level:3},{value:"Message InterruptDef",id:"interruptdef",level:3},{value:"Message JsonIndex",id:"jsonindex",level:3},{value:"Message Node",id:"node",level:3},{value:"Message NodeMigration",id:"nodemigration",level:3},{value:"Message NopNode",id:"nopnode",level:3},{value:"Message SleepNode",id:"sleepnode",level:3},{value:"Message StartMultipleThreadsNode",id:"startmultiplethreadsnode",level:3},{value:"Message StartMultipleThreadsNode.VariablesEntry",id:"startmultiplethreadsnodevariablesentry",level:3},{value:"Message StartThreadNode",id:"startthreadnode",level:3},{value:"Message StartThreadNode.VariablesEntry",id:"startthreadnodevariablesentry",level:3},{value:"Message ThreadRetentionPolicy",id:"threadretentionpolicy",level:3},{value:"Message ThreadSpec",id:"threadspec",level:3},{value:"Message ThreadSpec.NodesEntry",id:"threadspecnodesentry",level:3},{value:"Message ThreadSpecMigration",id:"threadspecmigration",level:3},{value:"Message ThreadSpecMigration.NodeMigrationsEntry",id:"threadspecmigrationnodemigrationsentry",level:3},{value:"Message ThreadVarDef",id:"threadvardef",level:3},{value:"Message ThrowEventNode",id:"throweventnode",level:3},{value:"Message UserTaskNode",id:"usertasknode",level:3},{value:"Message WaitForConditionNode",id:"waitforconditionnode",level:3},{value:"Message WaitForThreadsNode",id:"waitforthreadsnode",level:3},{value:"Message WaitForThreadsNode.ThreadToWaitFor",id:"waitforthreadsnodethreadtowaitfor",level:3},{value:"Message WaitForThreadsNode.ThreadsToWaitFor",id:"waitforthreadsnodethreadstowaitfor",level:3},{value:"Message WfSpec",id:"wfspec",level:3},{value:"Message WfSpec.ParentWfSpecReference",id:"wfspecparentwfspecreference",level:3},{value:"Message WfSpec.ThreadSpecsEntry",id:"wfspecthreadspecsentry",level:3},{value:"Message WfSpecVersionMigration",id:"wfspecversionmigration",level:3},{value:"Message WfSpecVersionMigration.ThreadSpecMigrationsEntry",id:"wfspecversionmigrationthreadspecmigrationsentry",level:3},{value:"Message WorkflowRetentionPolicy",id:"workflowretentionpolicy",level:3},{value:"Message WorkflowEvent",id:"workflowevent",level:3},{value:"Message WorkflowEventDef",id:"workfloweventdef",level:3},{value:"LittleHorse Enums",id:"littlehorse-enums",level:2},{value:"Enum ACLAction",id:"aclaction",level:3},{value:"Enum ACLResource",id:"aclresource",level:3},{value:"Enum LHErrorType",id:"lherrortype",level:3},{value:"Enum LHStatus",id:"lhstatus",level:3},{value:"Enum MetadataStatus",id:"metadatastatus",level:3},{value:"Enum MetricsWindowLength",id:"metricswindowlength",level:3},{value:"Enum TaskStatus",id:"taskstatus",level:3},{value:"Enum VariableType",id:"variabletype",level:3},{value:"Enum Comparator",id:"comparator",level:3},{value:"Enum UTActionTrigger.UTHook",id:"utactiontriggeruthook",level:3},{value:"Enum VariableMutationType",id:"variablemutationtype",level:3},{value:"Enum WaitForThreadsRun.WaitingThreadStatus",id:"waitforthreadsrunwaitingthreadstatus",level:3},{value:"Enum AllowedUpdateType",id:"allowedupdatetype",level:3},{value:"Enum SearchNodeRunRequest.NodeType",id:"searchnoderunrequestnodetype",level:3},{value:"Enum SaveUserTaskRunProgressRequest.SaveUserTaskRunAssignmentPolicy",id:"saveusertaskrunprogressrequestsaveusertaskrunassignmentpolicy",level:3},{value:"Enum UserTaskRunStatus",id:"usertaskrunstatus",level:3},{value:"Enum ThreadType",id:"threadtype",level:3},{value:"Enum FailureHandlerDef.LHFailureType",id:"failurehandlerdeflhfailuretype",level:3},{value:"Enum WfRunVariableAccessLevel",id:"wfrunvariableaccesslevel",level:3}];function a(e){const s={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"littlehorse-api-reference",children:"LittleHorse API Reference"})}),"\n",(0,r.jsxs)(s.p,{children:["The LittleHorse Server exposes a GRPC API to its clients. For most general usage of LittleHorse, you ",(0,r.jsx)(s.em,{children:"will not"})," need to\nread the raw protobuf schema. Common LittleHorse client actions fall into three general categories:"]}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsxs)(s.li,{children:["Developing a Task Worker, which is handled by our ",(0,r.jsx)(s.a,{href:"/docs/developer-guide/task-worker-development",children:"Task Worker SDK's"}),"."]}),"\n",(0,r.jsxs)(s.li,{children:["Developing a WfSpec, which is handled by our ",(0,r.jsxs)(s.a,{href:"/docs/developer-guide/wfspec-development",children:[(0,r.jsx)(s.code,{children:"WfSpec"})," SDK's"]}),"."]}),"\n",(0,r.jsxs)(s.li,{children:["Running and interacting with ",(0,r.jsx)(s.code,{children:"WfRun"}),"'s, which is documented in our ",(0,r.jsx)(s.a,{href:"/docs/developer-guide/grpc",children:'"Using the API"'})," docs."]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["However, the highly curious reader might want to see the actual GRPC and Protobuf specification. The docs on this page\nare autogenerated from our actual ",(0,r.jsx)(s.a,{href:"https://github.com/littlehorse-enterprises/littlehorse/tree/master/schemas",children:"protobuf files"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"The documentation of what the specific protobuf fields mean is potentially useful for advanced Jedi Master use-cases."}),"\n",(0,r.jsx)(s.p,{children:"Happy Reading!"}),"\n",(0,r.jsx)(s.h2,{id:"littlehorse-grpc-api",children:"LittleHorse GRPC API"}),"\n",(0,r.jsxs)(s.p,{children:["The LittleHorse GRPC API is the backbone of the clients that you get in all of our SDK's. Every ",(0,r.jsx)(s.code,{children:"LHConfig"})," object\ngives you a GRPC stub to access the API. Most common operations are already documented with code examples in different\nlanguages ",(0,r.jsx)(s.a,{href:"/docs/developer-guide/grpc",children:"here"}),", but we put this here for the true Jedi Masters."]}),"\n",(0,r.jsxs)(s.h3,{id:"puttaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"PutTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#puttaskdefrequest",children:"PutTaskDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdef",children:"TaskDef"})}),(0,r.jsx)(s.td,{children:"Creates a TaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"gettaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"GetTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdef",children:"TaskDef"})}),(0,r.jsx)(s.td,{children:"Gets a TaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"gettaskworkergroup",children:["RPC ",(0,r.jsx)(s.code,{children:"GetTaskWorkerGroup"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskworkergroup",children:"TaskWorkerGroup"})}),(0,r.jsx)(s.td,{children:"Gets the registered task worker group associated with a specific TaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putexternaleventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"PutExternalEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putexternaleventdefrequest",children:"PutExternalEventDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdef",children:"ExternalEventDef"})}),(0,r.jsx)(s.td,{children:"Creates an ExternalEventDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getexternaleventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"GetExternalEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdef",children:"ExternalEventDef"})}),(0,r.jsx)(s.td,{children:"Gets an ExternalEventDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putworkfloweventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"PutWorkflowEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putworkfloweventdefrequest",children:"PutWorkflowEventDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdef",children:"WorkflowEventDef"})}),(0,r.jsx)(s.td,{children:"Creates a WorkflowEventDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putwfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"PutWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putwfspecrequest",children:"PutWfSpecRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspec",children:"WfSpec"})}),(0,r.jsx)(s.td,{children:"Creates a WfSpec."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getwfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"GetWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspec",children:"WfSpec"})}),(0,r.jsx)(s.td,{children:"Gets a WfSpec."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getlatestwfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"GetLatestWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#getlatestwfspecrequest",children:"GetLatestWfSpecRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspec",children:"WfSpec"})}),(0,r.jsx)(s.td,{children:"Returns the latest WfSpec with a specified name (and optionally a specified Major Version)."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"migratewfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"MigrateWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#migratewfspecrequest",children:"MigrateWfSpecRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspec",children:"WfSpec"})}),(0,r.jsxs)(s.td,{children:["EXPERIMENTAL: Migrates all WfRun's from one version of a WfSpec onto a newer version of the same WfSpec. This is useful for long-running WfRun's (eg. a 60-day marketing campaign) where you must update WfRun's that are in the RUNNING state rather than allowing them to run to completion.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"As of 0.7.2, this feature is only partially implemented."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putusertaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"PutUserTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putusertaskdefrequest",children:"PutUserTaskDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdef",children:"UserTaskDef"})}),(0,r.jsx)(s.td,{children:"Creates a UserTaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getusertaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"GetUserTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdefid",children:"UserTaskDefId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdef",children:"UserTaskDef"})}),(0,r.jsxs)(s.td,{children:["Gets a specific UserTaskDef.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"This RPC is highly useful for applications built around User Tasks. For example, a UI that dynamically displays form fields based on the User Task might first receive a UserTaskRun, then use that UserTaskRun to look up the UserTaskDef. The frontend would inspect the UserTaskDef and display a form field on the browser page for each field in the UserTaskDef."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getlatestusertaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"GetLatestUserTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#getlatestusertaskdefrequest",children:"GetLatestUserTaskDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdef",children:"UserTaskDef"})}),(0,r.jsx)(s.td,{children:"Returns the most recent UserTaskDef with a specific name."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"runwf",children:["RPC ",(0,r.jsx)(s.code,{children:"RunWf"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#runwfrequest",children:"RunWfRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrun",children:"WfRun"})}),(0,r.jsx)(s.td,{children:"Runs a WfSpec to create a WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"schedulewf",children:["RPC ",(0,r.jsx)(s.code,{children:"ScheduleWf"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#schedulewfrequest",children:"ScheduleWfRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrun",children:"ScheduledWfRun"})}),(0,r.jsx)(s.td,{children:"Schedule repeated WfRun based on a cron expression"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchscheduledwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchScheduledWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchscheduledwfrunrequest",children:"SearchScheduledWfRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunidlist",children:"ScheduledWfRunIdList"})}),(0,r.jsx)(s.td,{children:"Search for existing schedules"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getscheduledwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"GetScheduledWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunid",children:"ScheduledWfRunId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrun",children:"ScheduledWfRun"})}),(0,r.jsx)(s.td,{children:"Find a specific ScheduledWfRun"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"GetWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrun",children:"WfRun"})}),(0,r.jsx)(s.td,{children:"Gets a WfRun. Although useful for development and debugging, this RPC is not often used by applications."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getusertaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"GetUserTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrun",children:"UserTaskRun"})}),(0,r.jsx)(s.td,{children:"Loads a specific UserTaskRun. It includes information about to whom the UserTask is currently assigned, history of assignments and reassignments, and any context for that UserTaskRun which is specific to the WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"assignusertaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"AssignUserTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#assignusertaskrunrequest",children:"AssignUserTaskRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Change the ownership of a UserTaskRun to a new userId, userGroup, or both. The action will be reflected in your next call to SearchUserTaskRun. This RPC is useful for applications that are using User Tasks to build an internal task-list and wish to administer the tasks."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"completeusertaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"CompleteUserTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#completeusertaskrunrequest",children:"CompleteUserTaskRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsxs)(s.td,{children:["Completes a UserTaskRun. Includes the results of the UserTaskRun, the UserTaskRun Id, and the userId of the user who completes the UserTaskRun. Results in the UserTask NodeRun being completed, and unblocks the associated ThreadRun in the WfRun.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"This RPC is highly useful for applications built around a WfSpec that uses USER_TASK nodes."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"cancelusertaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"CancelUserTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#cancelusertaskrunrequest",children:"CancelUserTaskRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Cancels a UserTaskRun. This will result in an EXCEPTION being propagated to the WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"saveusertaskrunprogress",children:["RPC ",(0,r.jsx)(s.code,{children:"SaveUserTaskRunProgress"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#saveusertaskrunprogressrequest",children:"SaveUserTaskRunProgressRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrun",children:"UserTaskRun"})}),(0,r.jsxs)(s.td,{children:["Saves the results of a UserTaskRun and logs who saved the content.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),(0,r.jsxs)("li",{children:[" Throws FAILED_PRECONDITION if the UserTaskRun is in the ",(0,r.jsx)(s.code,{children:"DONE"})," or ",(0,r.jsx)(s.code,{children:"CANCELLED"})," state."]})," ",(0,r.jsxs)("li",{children:[" If ",(0,r.jsx)(s.code,{children:"policy"})," is set to ",(0,r.jsx)(s.code,{children:"FAIL_IF_CLAIMED_BY_OTHER"}),", returns ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"})," if the ",(0,r.jsx)(s.code,{children:"user_id"})," field of the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," does not match the ",(0,r.jsx)(s.code,{children:"user_id"})," of the request."]})]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listusertaskruns",children:["RPC ",(0,r.jsx)(s.code,{children:"ListUserTaskRuns"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listusertaskrunrequest",children:"ListUserTaskRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunlist",children:"UserTaskRunList"})}),(0,r.jsx)(s.td,{children:"Lists all UserTaskRun's for a specific WfRun. Can be useful when using a WfRun to model an entity."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getnoderun",children:["RPC ",(0,r.jsx)(s.code,{children:"GetNodeRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderun",children:"NodeRun"})}),(0,r.jsx)(s.td,{children:"Gets a specific NodeRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listnoderuns",children:["RPC ",(0,r.jsx)(s.code,{children:"ListNodeRuns"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listnoderunsrequest",children:"ListNodeRunsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunlist",children:"NodeRunList"})}),(0,r.jsx)(s.td,{children:"Lists all NodeRun's for a specific WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"gettaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"GetTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrun",children:"TaskRun"})}),(0,r.jsx)(s.td,{children:"Gets a specific TaskRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listtaskruns",children:["RPC ",(0,r.jsx)(s.code,{children:"ListTaskRuns"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listtaskrunsrequest",children:"ListTaskRunsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunlist",children:"TaskRunList"})}),(0,r.jsx)(s.td,{children:"Lists all TaskRun's for a specific WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getvariable",children:["RPC ",(0,r.jsx)(s.code,{children:"GetVariable"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableid",children:"VariableId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variable",children:"Variable"})}),(0,r.jsx)(s.td,{children:"Get the value of a specific Variable. When using a WfRun to model an entity, this RPC is useful for retrieving information. It is equivalent to looking up the value of a column for a specific row in a SQL table."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listvariables",children:["RPC ",(0,r.jsx)(s.code,{children:"ListVariables"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listvariablesrequest",children:"ListVariablesRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablelist",children:"VariableList"})}),(0,r.jsx)(s.td,{children:"List all Variables from a WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putexternalevent",children:["RPC ",(0,r.jsx)(s.code,{children:"PutExternalEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putexternaleventrequest",children:"PutExternalEventRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externalevent",children:"ExternalEvent"})}),(0,r.jsx)(s.td,{children:"Post an ExternalEvent. This RPC is highly useful for"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getexternalevent",children:["RPC ",(0,r.jsx)(s.code,{children:"GetExternalEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externalevent",children:"ExternalEvent"})}),(0,r.jsx)(s.td,{children:"Get a specific ExternalEvent."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"awaitworkflowevent",children:["RPC ",(0,r.jsx)(s.code,{children:"AwaitWorkflowEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#awaitworkfloweventrequest",children:"AwaitWorkflowEventRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workflowevent",children:"WorkflowEvent"})}),(0,r.jsxs)(s.td,{children:["Waits for a WorkflowEvent to be thrown by a given WfRun. Returns immediately if a matching WorkflowEvent has already been thrown; throws a DEADLINE_EXCEEDED error if the WorkflowEvent is not thrown before the deadline specified by the client.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"To specify the deadline, the client should use GRPC deadlines."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getworkfloweventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"GetWorkflowEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdef",children:"WorkflowEventDef"})}),(0,r.jsx)(s.td,{children:"Get a specific WorkflowEventDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getworkflowevent",children:["RPC ",(0,r.jsx)(s.code,{children:"GetWorkflowEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventid",children:"WorkflowEventId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workflowevent",children:"WorkflowEvent"})}),(0,r.jsx)(s.td,{children:"Get a specific WorkflowEvent."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listexternalevents",children:["RPC ",(0,r.jsx)(s.code,{children:"ListExternalEvents"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listexternaleventsrequest",children:"ListExternalEventsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventlist",children:"ExternalEventList"})}),(0,r.jsx)(s.td,{children:"List ExternalEvent's for a specific WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listworkflowevents",children:["RPC ",(0,r.jsx)(s.code,{children:"ListWorkflowEvents"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listworkfloweventsrequest",children:"ListWorkflowEventsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventlist",children:"WorkflowEventList"})}),(0,r.jsx)(s.td,{children:"List WorkflowEvent's for a specific WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchwfrunrequest",children:"SearchWfRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunidlist",children:"WfRunIdList"})}),(0,r.jsx)(s.td,{children:"Search for WfRun's. This RPC is highly useful for applications that store data in LittleHorse and need to find a specific WfRun based on certain indexed fields."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchnoderun",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchNodeRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchnoderunrequest",children:"SearchNodeRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunidlist",children:"NodeRunIdList"})}),(0,r.jsx)(s.td,{children:"Search for NodeRun's. This RPC is useful for monitoring and finding bugs in your workflows or Task Workers."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchtaskrunrequest",children:"SearchTaskRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunidlist",children:"TaskRunIdList"})}),(0,r.jsx)(s.td,{children:"Search for TaskRun's. This RPC is useful for finding bugs in your Task Workers."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchusertaskrun",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchUserTaskRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchusertaskrunrequest",children:"SearchUserTaskRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunidlist",children:"UserTaskRunIdList"})}),(0,r.jsx)(s.td,{children:"Search for UserTaskRun's. This RPC is highly useful for applications that connect human end-users to LittleHorse: it enables you to find all tasks assigned to a specific person or group of people."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchvariable",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchVariable"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchvariablerequest",children:"SearchVariableRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableidlist",children:"VariableIdList"})}),(0,r.jsx)(s.td,{children:"Search for Variable's. This RPC is highly useful for applications that store data in LittleHorse and need to find a specific WfRun based on certain indexed fields."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchexternalevent",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchExternalEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchexternaleventrequest",children:"SearchExternalEventRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventidlist",children:"ExternalEventIdList"})}),(0,r.jsx)(s.td,{children:"Search for ExternalEvent's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchworkflowevent",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchWorkflowEvent"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchworkfloweventrequest",children:"SearchWorkflowEventRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventidlist",children:"WorkflowEventIdList"})}),(0,r.jsx)(s.td,{children:"Search for WorkflowEvents's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchtaskdefrequest",children:"SearchTaskDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefidlist",children:"TaskDefIdList"})}),(0,r.jsx)(s.td,{children:"Search for TaskDef's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchusertaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchUserTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchusertaskdefrequest",children:"SearchUserTaskDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdefidlist",children:"UserTaskDefIdList"})}),(0,r.jsx)(s.td,{children:"Search for UserTaskDef's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchwfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchwfspecrequest",children:"SearchWfSpecRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecidlist",children:"WfSpecIdList"})}),(0,r.jsx)(s.td,{children:"Search for WfSpec's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchexternaleventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchExternalEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchexternaleventdefrequest",children:"SearchExternalEventDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefidlist",children:"ExternalEventDefIdList"})}),(0,r.jsx)(s.td,{children:"Search for ExternalEventDef's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchworkfloweventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchWorkflowEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchworkfloweventdefrequest",children:"SearchWorkflowEventDefRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefidlist",children:"WorkflowEventDefIdList"})}),(0,r.jsx)(s.td,{children:"Search for WorkflowEventDef's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtenant",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchTenant"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchtenantrequest",children:"SearchTenantRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenantidlist",children:"TenantIdList"})}),(0,r.jsx)(s.td,{children:"Search for all available TenantIds for current Principal"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchprincipal",children:["RPC ",(0,r.jsx)(s.code,{children:"SearchPrincipal"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchprincipalrequest",children:"SearchPrincipalRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principalidlist",children:"PrincipalIdList"})}),(0,r.jsx)(s.td,{})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"registertaskworker",children:["RPC ",(0,r.jsx)(s.code,{children:"RegisterTaskWorker"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#registertaskworkerrequest",children:"RegisterTaskWorkerRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#registertaskworkerresponse",children:"RegisterTaskWorkerResponse"})}),(0,r.jsx)(s.td,{children:"Used by the Task Worker to: 1. Tell the LH Server that the Task Worker has joined the Task Worker Group. 2. Receive the assignemnt of LH Server's to poll from. Generally, you won't use this request manually."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"polltask",children:["RPC ",(0,r.jsx)(s.code,{children:"PollTask"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#polltaskrequest",children:"PollTaskRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#polltaskresponse",children:"PollTaskResponse"})}),(0,r.jsx)(s.td,{children:"Used by Task Workers to listen for TaskRuns on the Task Queue. Generally, you won't use this RPC manually."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"reporttask",children:["RPC ",(0,r.jsx)(s.code,{children:"ReportTask"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#reporttaskrun",children:"ReportTaskRun"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Used by Task Workers to report the result of a TaskRun. Generally, you won't use this rpc manually."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"stopwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"StopWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#stopwfrunrequest",children:"StopWfRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Move a WfRun or a specific ThreadRun in that WfRun to the HALTED state."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"resumewfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"ResumeWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#resumewfrunrequest",children:"ResumeWfRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Resumes a WfRun or a specific ThreadRun of a WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"rescuethreadrun",children:["RPC ",(0,r.jsx)(s.code,{children:"RescueThreadRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#rescuethreadrunrequest",children:"RescueThreadRunRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrun",children:"WfRun"})}),(0,r.jsxs)(s.td,{children:["Rescues a failed ThreadRun (in the ERROR state only) by restarting it from the point of failure. Useful if a bug in Task Worker implementation caused a WfRun to fail and you did not have a FailureHandler for that NodeRun.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"The specified ",(0,r.jsx)(s.code,{children:"ThreadRun"})," must be in a state where it's latest ",(0,r.jsx)(s.code,{children:"NodeRun"})," is: ",(0,r.jsx)("br",{})," - In the ",(0,r.jsx)(s.code,{children:"ERROR"})," state.",(0,r.jsx)("br",{})," - Has no ",(0,r.jsx)(s.code,{children:"FailureHandler"})," ",(0,r.jsx)(s.code,{children:"ThreadRun"}),"s ",(0,r.jsx)("br",{})," - The parent ",(0,r.jsx)(s.code,{children:"ThreadRun"}),", or any parent of the parent, has not handled the ",(0,r.jsx)(s.code,{children:"Failure"})," yet.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If that is not true, then the ",(0,r.jsx)(s.code,{children:"ThreadRun"})," cannot be rescued and the request will return ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"}),"."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletewfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deletewfrunrequest",children:"DeleteWfRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes a WfRun. The WfRun cannot be in the RUNNING state."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletetaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deletetaskdefrequest",children:"DeleteTaskDefRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes a TaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletewfspec",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteWfSpec"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deletewfspecrequest",children:"DeleteWfSpecRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes a WfSpec."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteusertaskdef",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteUserTaskDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deleteusertaskdefrequest",children:"DeleteUserTaskDefRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes a UserTaskDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteexternaleventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteExternalEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deleteexternaleventdefrequest",children:"DeleteExternalEventDefRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes an ExternalEventDef."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteworkfloweventdef",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteWorkflowEventDef"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deleteworkfloweventdefrequest",children:"DeleteWorkflowEventDefRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteprincipal",children:["RPC ",(0,r.jsx)(s.code,{children:"DeletePrincipal"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deleteprincipalrequest",children:"DeletePrincipalRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsxs)(s.td,{children:["Deletes a ",(0,r.jsx)(s.code,{children:"Principal"}),". Fails with ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"})," if the specified ",(0,r.jsx)(s.code,{children:"Principal"})," is the last remaining ",(0,r.jsx)(s.code,{children:"Principal"})," with admin permissions. Admin permissions are defined as having the ",(0,r.jsx)(s.code,{children:"global_acls"})," of ",(0,r.jsx)(s.code,{children:"ALL_ACTIONS"})," over the ",(0,r.jsx)(s.code,{children:"ACL_ALL_RESOURCES"})," scope."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletescheduledwfrun",children:["RPC ",(0,r.jsx)(s.code,{children:"DeleteScheduledWfRun"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#deletescheduledwfrunrequest",children:"DeleteScheduledWfRunRequest"})}),(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:"Deletes a scheduled run and prevents any further associated WfRun from being executed."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"gettaskdefmetricswindow",children:["RPC ",(0,r.jsx)(s.code,{children:"GetTaskDefMetricsWindow"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefmetricsqueryrequest",children:"TaskDefMetricsQueryRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefmetrics",children:"TaskDefMetrics"})}),(0,r.jsx)(s.td,{children:"Returns TaskDef Metrics for a specific TaskDef and a specific time window."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getwfspecmetricswindow",children:["RPC ",(0,r.jsx)(s.code,{children:"GetWfSpecMetricsWindow"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecmetricsqueryrequest",children:"WfSpecMetricsQueryRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecmetrics",children:"WfSpecMetrics"})}),(0,r.jsx)(s.td,{children:"Returns WfSpec Metrics for a specific WfSpec and a specific time window."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listtaskdefmetrics",children:["RPC ",(0,r.jsx)(s.code,{children:"ListTaskDefMetrics"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listtaskmetricsrequest",children:"ListTaskMetricsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listtaskmetricsresponse",children:"ListTaskMetricsResponse"})}),(0,r.jsx)(s.td,{children:"Returns a list of TaskDef Metrics Windows."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listwfspecmetrics",children:["RPC ",(0,r.jsx)(s.code,{children:"ListWfSpecMetrics"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listwfmetricsrequest",children:"ListWfMetricsRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#listwfmetricsresponse",children:"ListWfMetricsResponse"})}),(0,r.jsx)(s.td,{children:"Returns a list of WfSpec Metrics Windows."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"puttenant",children:["RPC ",(0,r.jsx)(s.code,{children:"PutTenant"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#puttenantrequest",children:"PutTenantRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenant",children:"Tenant"})}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: Creates another Tenant in the LH Server."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"gettenant",children:["RPC ",(0,r.jsx)(s.code,{children:"GetTenant"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenantid",children:"TenantId"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenant",children:"Tenant"})}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: Gets a Tenant from the LH Server."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"putprincipal",children:["RPC ",(0,r.jsx)(s.code,{children:"PutPrincipal"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putprincipalrequest",children:"PutPrincipalRequest"})}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principal",children:"Principal"})}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: Creates an Principal."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"whoami",children:["RPC ",(0,r.jsx)(s.code,{children:"Whoami"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principal",children:"Principal"})}),(0,r.jsx)(s.td,{children:"Returns the Principal of the caller."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getserverversion",children:["RPC ",(0,r.jsx)(s.code,{children:"GetServerVersion"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Request Type"}),(0,r.jsx)(s.th,{children:"Response Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:".google.protobuf.Empty"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serverversionresponse",children:"ServerVersionResponse"})}),(0,r.jsx)(s.td,{children:"Gets the version of the LH Server."})]})})]}),"\n",(0,r.jsx)(s.h2,{id:"littlehorse-protobuf-schemas",children:"LittleHorse Protobuf Schemas"}),"\n",(0,r.jsx)(s.p,{children:"This section contains the exact schemas for every object in our public API."}),"\n",(0,r.jsxs)(s.h3,{id:"deleteprincipalrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeletePrincipalRequest"})]}),"\n",(0,r.jsxs)(s.p,{children:["Deletes a ",(0,r.jsx)(s.code,{children:"Principal"}),". Fails with ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"})," if the specified ",(0,r.jsx)(s.code,{children:"Principal"})," is the last\nadmin ",(0,r.jsx)(s.code,{children:"Principal"}),"."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principalid",children:"PrincipalId"})}),(0,r.jsxs)(s.td,{children:["The ID of the ",(0,r.jsx)(s.code,{children:"Principal"})," to delete."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"principal",children:["Message ",(0,r.jsx)(s.code,{children:"Principal"})]}),"\n",(0,r.jsx)(s.p,{children:"A Principal represents the identity of a client of LittleHorse, whether human or\nmachine. The ACL's on the Principal control what actions the client is allowed\nto take."}),"\n",(0,r.jsx)(s.p,{children:"A Principal is not scoped to a Tenant; rather, a Principal is scoped to the Cluster\nand may have access to one or more Tenants."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principalid",children:"PrincipalId"})}),(0,r.jsxs)(s.td,{children:["The ID of the Principal. In OAuth for human users, this is the user_id. In OAuth for machine clients, this is the Client ID.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"mTLS for Principal identification is not yet implemented."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time at which the Principal was created."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"per_tenant_acls"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principalpertenantaclsentry",children:"Principal.PerTenantAclsEntry"})}),(0,r.jsxs)(s.td,{children:["Maps a Tenant ID to a list of ACL's that the Principal has permission to execute ",(0,r.jsx)(s.em,{children:"within that Tenant"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"global_acls"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serveracls",children:"ServerACLs"})}),(0,r.jsxs)(s.td,{children:["Sets permissions that this Principal has ",(0,r.jsx)(s.em,{children:"for any Tenant"})," in the LH Cluster."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"principalpertenantaclsentry",children:["Message ",(0,r.jsx)(s.code,{children:"Principal.PerTenantAclsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serveracls",children:"ServerACLs"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putprincipalrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutPrincipalRequest"})]}),"\n",(0,r.jsxs)(s.p,{children:["Creates or updates a Principal. If this request would remove admin privileges from the\nlast admin principal (i.e. ",(0,r.jsx)(s.code,{children:"ALL_ACTIONS"})," over ",(0,r.jsx)(s.code,{children:"ACL_ALL_RESOURCES"})," in the ",(0,r.jsx)(s.code,{children:"global_acls"}),"),\nthen the RPC throws ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"}),"."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The ID of the Principal that we are creating."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"per_tenant_acls"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putprincipalrequestpertenantaclsentry",children:"PutPrincipalRequest.PerTenantAclsEntry"})}),(0,r.jsx)(s.td,{children:"The per-tenant ACL's for the Principal"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"global_acls"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serveracls",children:"ServerACLs"})}),(0,r.jsx)(s.td,{children:"The ACL's for the principal in all tenants"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"overwrite"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsxs)(s.td,{children:["If this is set to false and a ",(0,r.jsx)(s.code,{children:"Principal"})," with the same ",(0,r.jsx)(s.code,{children:"id"})," already exists ",(0,r.jsx)(s.em,{children:"and"})," has different ACL's configured, then the RPC throws ",(0,r.jsx)(s.code,{children:"ALREADY_EXISTS"}),".",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If this is set to ",(0,r.jsx)(s.code,{children:"true"}),", then the RPC will override hte"]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putprincipalrequestpertenantaclsentry",children:["Message ",(0,r.jsx)(s.code,{children:"PutPrincipalRequest.PerTenantAclsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serveracls",children:"ServerACLs"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"puttenantrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutTenantRequest"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"serveracl",children:["Message ",(0,r.jsx)(s.code,{children:"ServerACL"})]}),"\n",(0,r.jsxs)(s.p,{children:["Represents a specific set of permissions over a specific set of objects\nin a Tenant. This is a ",(0,r.jsx)(s.em,{children:"positive"})," permission."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"resources"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#aclresource",children:"ACLResource"})}),(0,r.jsx)(s.td,{children:"The resource types over which permission is granted."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"allowed_actions"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#aclaction",children:"ACLAction"})}),(0,r.jsx)(s.td,{children:"The actions that are permitted."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"resource_filter"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["If set, then only the resources with this exact name are allowed. For example, the ",(0,r.jsx)(s.code,{children:"READ"})," and ",(0,r.jsx)(s.code,{children:"RUN"})," ",(0,r.jsx)(s.code,{children:"allowed_actions"})," over ",(0,r.jsx)(s.code,{children:"ACL_TASK"})," with ",(0,r.jsx)(s.code,{children:"name"})," == ",(0,r.jsx)(s.code,{children:"my-task"})," allows a Task Worker to only execute the ",(0,r.jsx)(s.code,{children:"my-task"})," TaskDef.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If ",(0,r.jsx)(s.code,{children:"name"})," and ",(0,r.jsx)(s.code,{children:"prefix"})," are unset, then the ACL applies to all resources of the specified types."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"resource_filter"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["If set, then only the resources whose names match this prefix are allowed.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If ",(0,r.jsx)(s.code,{children:"name"})," and ",(0,r.jsx)(s.code,{children:"prefix"})," are unset, then the ACL applies to all resources of the specified types."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"serveracls",children:["Message ",(0,r.jsx)(s.code,{children:"ServerACLs"})]}),"\n",(0,r.jsx)(s.p,{children:"List of ACL's for LittleHorse"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"acls"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#serveracl",children:"ServerACL"})}),(0,r.jsx)(s.td,{children:"The associated ACL's"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"tenant",children:["Message ",(0,r.jsx)(s.code,{children:"Tenant"})]}),"\n",(0,r.jsx)(s.p,{children:"A Tenant is a logically isolated environment within LittleHorse. All workflows and\nassociated data (WfSpec, WfRun, TaskDef, TaskRun, NodeRun, etc) are scoped to within\na Tenant."}),"\n",(0,r.jsx)(s.p,{children:"Future versions will include quotas on a per-Tenant basis."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenantid",children:"TenantId"})}),(0,r.jsx)(s.td,{children:"The ID of the Tenant."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time at which the Tenant was created."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"exponentialbackoffretrypolicy",children:["Message ",(0,r.jsx)(s.code,{children:"ExponentialBackoffRetryPolicy"})]}),"\n",(0,r.jsxs)(s.p,{children:["Defines an Exponential backoff policy for TaskRun retries. The delay for a retry\nattempt ",(0,r.jsx)(s.code,{children:"N"})," is defined as:"]}),"\n",(0,r.jsx)(s.p,{children:"min(base_interval_ms * (multiplier ^(N-1)), max_delay_ms)"}),"\n",(0,r.jsx)(s.p,{children:"Note that timers in LittleHorse have a resolution of about 500-1000 milliseconds,\nso timing is not exact."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"base_interval_ms"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Base delay in ms for the first retry. Note that in LittleHorse, timers have a resolution of 500-1000 milliseconds. Must be greater than zero."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"max_delay_ms"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Maximum delay in milliseconds between retries."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"multiplier"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"float"}),(0,r.jsx)(s.td,{children:"The multiplier to use in calculating the retry backoff policy. We recommend starting with 2.0. Must be at least 1.0."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"tasknode",children:["Message ",(0,r.jsx)(s.code,{children:"TaskNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines a TaskRun execution. Used in a Node and also in the UserTask Trigger Actions."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"task_to_execute"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"dynamic_task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"task_to_execute"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"timeout_seconds"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"How long until LittleHorse determines that the Task Worker had a technical ERROR if the worker does not yet reply to the Server. This is determined on a per-Attempt basis."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retries"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["Configures the amount of retries allowed on this TaskNode.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Retryable errors include: - TASK_TIMEOUT: the TaskRun was started but the scheduler didn't hear back from the Task Worker in time. - TASK_FAILED: the Task Worker reported an unexpected ",(0,r.jsx)(s.em,{children:"technical"})," ERROR when executing the Task Function.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Other result codes are not retryable (including TASK_OUTPUT_SERIALIZING_ERROR, TASK_INPUT_VAR_SUB_ERROR, and TASK_EXCEPTION)."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exponential_backoff"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#exponentialbackoffretrypolicy",children:"ExponentialBackoffRetryPolicy"})}),(0,r.jsx)(s.td,{children:"If this field is set, then retries will use Exponential Backoff."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Input variables into the TaskDef."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"utactiontrigger",children:["Message ",(0,r.jsx)(s.code,{children:"UTActionTrigger"})]}),"\n",(0,r.jsx)(s.p,{children:"A UTActionTrigger triggers an action upon certain lifecycle hooks\nin a User Task. Actions include:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"re-assign the User Task Run"}),"\n",(0,r.jsx)(s.li,{children:"cancel the User Task Run"}),"\n",(0,r.jsx)(s.li,{children:"execute a Reminder Task"}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Hooks include:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"Upon creation of the UserTaskRun"}),"\n",(0,r.jsx)(s.li,{children:"Upon rescheduling the UserTaskRun"}),"\n"]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"action"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#utactiontriggerutatask",children:"UTActionTrigger.UTATask"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"cancel"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"action"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#utactiontriggerutacancel",children:"UTActionTrigger.UTACancel"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"reassign"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"action"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#utactiontriggerutareassign",children:"UTActionTrigger.UTAReassign"})}),(0,r.jsx)(s.td,{children:"later on, might enable scheduling entire ThreadRuns"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"delay_seconds"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"The Action is triggered some time after the Hook matures. The delay is controlled by this field."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"hook"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#utactiontriggeruthook",children:"UTActionTrigger.UTHook"})}),(0,r.jsx)(s.td,{children:"The hook on which this UserTaskAction is scheduled."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"utactiontriggerutacancel",children:["Message ",(0,r.jsx)(s.code,{children:"UTActionTrigger.UTACancel"})]}),"\n",(0,r.jsx)(s.p,{children:"A UserTaskAction that causes a UserTaskRun to be CANCELLED when it fires."}),"\n",(0,r.jsxs)(s.h3,{id:"utactiontriggerutareassign",children:["Message ",(0,r.jsx)(s.code,{children:"UTActionTrigger.UTAReassign"})]}),"\n",(0,r.jsx)(s.p,{children:"A UserTaskAction that causes a UserTaskRun to be reassigned when it fires."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"A variable assignment that resolves to a STR representing the new user_id. If not set, the user_id of the UserTaskRun will be un-set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"A variable assignment that resolves to a STR representing the new user_group. If not set, the user_group of the UserTaskRun will be un-set."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"utactiontriggerutatask",children:["Message ",(0,r.jsx)(s.code,{children:"UTActionTrigger.UTATask"})]}),"\n",(0,r.jsx)(s.p,{children:"A UserTaskAction that causes a TaskRun to be scheduled when it fires."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tasknode",children:"TaskNode"})}),(0,r.jsx)(s.td,{children:"The specification of the Task to schedule."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"mutations"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablemutation",children:"VariableMutation"})}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: Any variables in the ThreadRun which we should mutate."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variableassignment",children:["Message ",(0,r.jsx)(s.code,{children:"VariableAssignment"})]}),"\n",(0,r.jsx)(s.p,{children:"A VariableAssignment is used within a WfSpec to determine how a value should be\nassigned in the context of a specific WfRun. For example, in a TASK node, you\nuse a VariableAssignment for each input parameter to determine how the value\nis set."}),"\n",(0,r.jsx)(s.p,{children:"Note that the VariableAssignment is normally handled by the SDK; you shouldn't\nhave to worry about this in daily LittleHorse usage."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"json_path"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["If you provide a ",(0,r.jsx)(s.code,{children:"variable_name"})," and the specified variable is JSON_OBJ or JSON_ARR type, then you may also provide a json_path which makes the VariableAssignment resolve to the specified field."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variable_name"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"source"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Assign the value from a variable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"literal_value"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"source"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Assign a literal value"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"format_string"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"source"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignmentformatstring",children:"VariableAssignment.FormatString"})}),(0,r.jsx)(s.td,{children:"Assign a format string"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variableassignmentformatstring",children:["Message ",(0,r.jsx)(s.code,{children:"VariableAssignment.FormatString"})]}),"\n",(0,r.jsx)(s.p,{children:"A FormatString formats a template String with values from the WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"format"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsxs)(s.td,{children:['A VariableAssignment which must resolve to a String that has format args. A valid string is "This is a format string with three args: ',0,", ",1,", ",2,'"']})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"args"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"VariableAssignments which fill out the args."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variabledef",children:["Message ",(0,r.jsx)(s.code,{children:"VariableDef"})]}),"\n",(0,r.jsx)(s.p,{children:"Declares a Variable."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabletype",children:"VariableType"})}),(0,r.jsx)(s.td,{children:"The Type of the variable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the variable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"default_value"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Optional default value if the variable isn't set; for example, in a ThreadRun if you start a ThreadRun or WfRun without passing a variable in, then this is used."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"masked_value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"If true, the variable value will show as a masked string."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variablemutation",children:["Message ",(0,r.jsx)(s.code,{children:"VariableMutation"})]}),"\n",(0,r.jsx)(s.p,{children:"A VariableMutation defines a modification made to one of a ThreadRun's variables.\nThe LHS determines the variable that is modified; the operation determines how\nit is modified, and the RHS is the input to the operation."}),"\n",(0,r.jsx)(s.p,{children:"Day-to-day users of LittleHorse generally don't interact with this structure unless\nthey are writing their own WfSpec SDK."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"lhs_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the variable to mutate"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"lhs_json_path"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate a specific sub-field of the variable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"operation"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablemutationtype",children:"VariableMutationType"})}),(0,r.jsx)(s.td,{children:"Defines the operation that we are executing."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"source_variable"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"rhs_value"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Set the source_variable as the RHS to use another variable from the workflow to as the RHS/"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"literal_value"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"rhs_value"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Use a literal value as the RHS."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_output"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"rhs_value"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablemutationnodeoutputsource",children:"VariableMutation.NodeOutputSource"})}),(0,r.jsx)(s.td,{children:"Use the output of the current node as the RHS."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variablemutationnodeoutputsource",children:["Message ",(0,r.jsx)(s.code,{children:"VariableMutation.NodeOutputSource"})]}),"\n",(0,r.jsx)(s.p,{children:"Specifies to use the output of a NodeRun as the RHS."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"jsonpath"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Use this specific field from a JSON output"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"externalevent",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEvent"})]}),"\n",(0,r.jsx)(s.p,{children:"An ExternalEvent represents A Thing That Happened outside the context of a WfRun.\nGenerally, an ExternalEvent is used to represent a document getting signed, an incident\nbeing resolved, an order being fulfilled, etc."}),"\n",(0,r.jsx)(s.p,{children:"ExternalEvent's are created via the 'rpc PutExternalEvent'"}),"\n",(0,r.jsxs)(s.p,{children:["For more context on ExternalEvents, check our documentation here:\n",(0,r.jsx)(s.a,{href:"https://littlehorse.dev/docs/concepts/external-events",children:"https://littlehorse.dev/docs/concepts/external-events"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsxs)(s.td,{children:["The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId, and a unique guid which can be used for idempotency of the ",(0,r.jsx)(s.code,{children:"PutExternalEvent"})," rpc call."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the ExternalEvent was registered with LittleHorse."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The payload of this ExternalEvent."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_position"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT Node; note that in the case of an Interrupt the node_run_position will never be set), this is set to the number of the relevant NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"claimed"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether the ExternalEvent has been claimed by a WfRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventdef",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventDef"})]}),"\n",(0,r.jsx)(s.p,{children:"The ExternalEventDef defines the blueprint for an ExternalEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The id of the ExternalEventDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"When the ExternalEventDef was created."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retention_policy"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventretentionpolicy",children:"ExternalEventRetentionPolicy"})}),(0,r.jsxs)(s.td,{children:["The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the ExternalEvent ",(0,r.jsx)(s.strong,{children:"only before"})," it is matched with a WfRun."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventretentionpolicy",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventRetentionPolicy"})]}),"\n",(0,r.jsx)(s.p,{children:"Policy to determine how long an ExternalEvent is retained after creation if it\nis not yet claimed by a WfRun. Note that once a WfRun has been matched with the\nExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.\nIf not set, then ExternalEvent's are not deleted if they are not matched with\na WfRun."}),"\n",(0,r.jsxs)(s.p,{children:["A future version of LittleHorse will allow changing the retention_policy, which\nwill trigger a cleanup of old ",(0,r.jsx)(s.code,{children:"ExternalEvent"}),"s."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"seconds_after_put"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"ext_evt_gc_policy"})]}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Delete such an ExternalEvent X seconds after it has been registered if it has not yet been claimed by a WfRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"entrypointrun",children:["Message ",(0,r.jsx)(s.code,{children:"EntrypointRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for an ENTRYPOINT NodeRun. Currently Empty."}),"\n",(0,r.jsxs)(s.h3,{id:"exitrun",children:["Message ",(0,r.jsx)(s.code,{children:"ExitRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for an EXIT NodeRun. Currently Empty, will contain info\nabout ThreadRun Outputs once those are added in the future."}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventnoderun",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventNodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for an EXTERNAL_EVENT NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ExternalEventDefId that we are waiting for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"event_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time that the ExternalEvent arrived. Unset if still waiting."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"The ExternalEventId of the ExternalEvent. Unset if still waiting."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"timed_out"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether we had a timeout while waiting for the ExternalEvent to come."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"failure",children:["Message ",(0,r.jsx)(s.code,{children:"Failure"})]}),"\n",(0,r.jsx)(s.p,{children:"Denotes a failure that happened during execution of a NodeRun or the outgoing\nedges."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["The name of the failure. LittleHorse has certain built-in failures, all named in UPPER_UNDERSCORE_CASE. Such failures correspond with the ",(0,r.jsx)(s.code,{children:"LHStatus.ERROR"}),".",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Any Failure named in ",(0,r.jsx)(s.code,{children:"kebab-case"})," is a user-defined business ",(0,r.jsx)(s.code,{children:"EXCEPTION"}),", treated as an ",(0,r.jsx)(s.code,{children:"LHStatus.EXCEPTION"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"message"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The human-readable message associated with this Failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsxs)(s.td,{children:["A user-defined Failure can have a value; for example, in Java an Exception is an Object with arbitrary properties and behaviors.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Future versions of LH will allow FailureHandler threads to accept that value as an input variable."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"was_properly_handled"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"A boolean denoting whether a Failure Handler ThreadRun properly handled the Failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_handler_threadrun_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"If there is a defined failure handler for the NodeRun, then this field is set to the id of the failure handler thread run."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"noderun",children:["Message ",(0,r.jsx)(s.code,{children:"NodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"A NodeRun is a running instance of a Node in a ThreadRun. Note that a NodeRun\nis a Getable object, meaning it can be retried from the LittleHorse grpc API."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the ThreadRun's number, and the position of the NodeRun within that ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsxs)(s.td,{children:["The ID of the WfSpec that this NodeRun is from. This is not ",(0,r.jsx)(s.em,{children:"always"})," the same as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration feature."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_handler_ids"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"The status of this NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"arrival_time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the ThreadRun arrived at this NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"end_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the NodeRun was terminated (failed or completed)."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to which this NodeRun belongs."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the Node in the ThreadSpec that this NodeRun belongs to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"error_message"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"A human-readable error message intended to help developers diagnose WfSpec problems."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failures"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failure",children:"Failure"})}),(0,r.jsx)(s.td,{children:"A list of Failures thrown by this NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tasknoderun",children:"TaskNodeRun"})}),(0,r.jsx)(s.td,{children:"Denotes a TASK node, which runs a TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventnoderun",children:"ExternalEventNodeRun"})}),(0,r.jsx)(s.td,{children:"An EXTERNAL_EVENT node blocks until an ExternalEvent arrives."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"entrypoint"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#entrypointrun",children:"EntrypointRun"})}),(0,r.jsx)(s.td,{children:"An ENTRYPOINT node is the first thing that runs in a ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exit"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#exitrun",children:"ExitRun"})}),(0,r.jsx)(s.td,{children:"An EXIT node completes a ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_thread"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startthreadrun",children:"StartThreadRun"})}),(0,r.jsx)(s.td,{children:"A START_THREAD node starts a child ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wait_threads"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsrun",children:"WaitForThreadsRun"})}),(0,r.jsx)(s.td,{children:"A WAIT_THREADS node waits for one or more child ThreadRun's to complete."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"sleep"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#sleepnoderun",children:"SleepNodeRun"})}),(0,r.jsx)(s.td,{children:"A SLEEP node makes the ThreadRun block for a certain amount of time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertasknoderun",children:"UserTaskNodeRun"})}),(0,r.jsx)(s.td,{children:"A USER_TASK node waits until a human executes some work and reports the result."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_multiple_threads"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startmultiplethreadsrun",children:"StartMultipleThreadsRun"})}),(0,r.jsx)(s.td,{children:"A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a child ThreadRun for each element in the list."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"throw_event"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#throweventnoderun",children:"ThrowEventNodeRun"})}),(0,r.jsx)(s.td,{children:"A THROW_EVENT node throws a WorkflowEvent of a specified WorkflowEventDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wait_for_condition"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node_type"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforconditionrun",children:"WaitForConditionRun"})}),(0,r.jsx)(s.td,{children:"A WAIT_FOR_CONDITION node blocks the ThreadRun until the specified condition evaluates to True."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"sleepnoderun",children:["Message ",(0,r.jsx)(s.code,{children:"SleepNodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a SLEEP NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"maturation_time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["The time at which the NodeRun is ",(0,r.jsx)(s.em,{children:"SCHEDULED TO"}),' wake up. In rare cases, if the LH Server is back-pressuring clients due to extreme load, the timer event which marks the sleep node as "matured" may come in slightly late.']})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"matured"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether the SleepNodeRun has been matured."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startmultiplethreadsrun",children:["Message ",(0,r.jsx)(s.code,{children:"StartMultipleThreadsRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a START_MULTIPLE_THREADS NodeRun."}),"\n",(0,r.jsx)(s.p,{children:"Note: the output of this NodeRun, which can be used to mutate Variables,\nis a JSON_ARR variable containing the ID's of all the child threadRuns."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The thread_spec_name of the child thread_runs."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"child_thread_ids"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The list of all created child ThreadRun's"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startthreadrun",children:["Message ",(0,r.jsx)(s.code,{children:"StartThreadRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a START_THREAD NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"child_thread_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Contains the thread_run_number of the created Child ThreadRun, if it has been created already."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The thread_spec_name of the child thread_run."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"tasknoderun",children:["Message ",(0,r.jsx)(s.code,{children:"TaskNodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a TASK NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived at this TASK Node, then the task_run_id will be unset."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"throweventnoderun",children:["Message ",(0,r.jsx)(s.code,{children:"ThrowEventNodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a THROW_EVENT NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"workflow_event_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventid",children:"WorkflowEventId"})}),(0,r.jsxs)(s.td,{children:["The ID of the ",(0,r.jsx)(s.code,{children:"WorkflowEvent"})," that was thrown by this ",(0,r.jsx)(s.code,{children:"ThrowEventNodeRun"}),"."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertasknoderun",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskNodeRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a USER_TASK NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived at this USER_TASK node, then the user_task_run_id will be unset."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforconditionrun",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForConditionRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a WAIT_FOR_CONDITION NodeRun"}),"\n",(0,r.jsxs)(s.h3,{id:"waitforthreadsrun",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForThreadsRun"})]}),"\n",(0,r.jsx)(s.p,{children:"The sub-node structure for a WAIT_FOR_THREADS NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"threads"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsrunwaitforthread",children:"WaitForThreadsRun.WaitForThread"})}),(0,r.jsx)(s.td,{children:"The threads that are being waited for."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforthreadsrunwaitforthread",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForThreadsRun.WaitForThread"})]}),"\n",(0,r.jsx)(s.p,{children:"A 'WaitForThread' structure defines a thread that is being waited for."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_end_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun is still RUNNING, HALTED, or HALTING."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"The current status of the ThreadRun being waited for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The number of the ThreadRun being waited for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"waiting_status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsrunwaitingthreadstatus",children:"WaitForThreadsRun.WaitingThreadStatus"})}),(0,r.jsx)(s.td,{children:'The "waiting status" of this specific thread: whether it\'s still running, already done, handling a failure, or completely failed.'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_handler_thread_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"If there is a failure on the ThreadRun, and we have a failure handler defined for it, then we will start a failure handler for this threadrun. This field is the id of that threadRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventdefid",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventDefId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for ExternalEventDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"ExternalEventDef's are uniquedly identified by their name."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventid",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for an ExternalEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"WfRunId for the ExternalEvent. Note that every ExternalEvent is associated with a WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ExternalEventDef for this ExternalEvent."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"guid"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"A unique guid allowing for distinguishing this ExternalEvent from other events of the same ExternalEventDef and WfRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"noderunid",children:["Message ",(0,r.jsx)(s.code,{children:"NodeRunId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"ID of the WfRun for this NodeRun. Note that every NodeRun is associated with a WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"ThreadRun of this NodeRun. Note that each NodeRun belongs to a ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"position"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Position of this NodeRun within its ThreadRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"principalid",children:["Message ",(0,r.jsx)(s.code,{children:"PrincipalId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a Principal."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The id of this principal. In OAuth, this is the OAuth Client ID (for machine principals) or the OAuth User Id (for human principals)."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"scheduledwfrunid",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduledWfRunId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a ScheduledWfRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefid",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a TaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"TaskDef's are uniquely identified by their name."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefmetricsid",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefMetricsId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a specific window of TaskDef metrics."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The timestamp at which this metrics window starts."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The length of this window."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The TaskDefId that this metrics window reports on."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskrunid",children:["Message ",(0,r.jsx)(s.code,{children:"TaskRunId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a TaskRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"WfRunId for this TaskRun. Note that every TaskRun is associated with a WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_guid"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Unique identifier for this TaskRun. Unique among the WfRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskworkergroupid",children:["Message ",(0,r.jsx)(s.code,{children:"TaskWorkerGroupId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a TaskWorkerGroup."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"TaskWorkerGroups are uniquely identified by their TaskDefId."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"tenantid",children:["Message ",(0,r.jsx)(s.code,{children:"TenantId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a Tenant."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The Tenant ID."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskdefid",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskDefId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a UserTaskDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of a UserTaskDef"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Note that UserTaskDef's use simple versioning."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskrunid",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskRunId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a UserTaskRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"WfRunId for this UserTaskRun. Note that every UserTaskRun is associated with a WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_guid"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Unique identifier for this UserTaskRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variableid",children:["Message ",(0,r.jsx)(s.code,{children:"VariableId"})]}),"\n",(0,r.jsx)(s.p,{children:"Id for a Variable."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"WfRunId for the variable. Note that every Variable is associated with a WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Each Variable is owned by a specific ThreadRun inside the WfRun it belongs to. This is that ThreadRun's number."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the variable."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfrunid",children:["Message ",(0,r.jsx)(s.code,{children:"WfRunId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a WfRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The ID for this WfRun instance."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"A WfRun may have a parent WfRun. If so, this field is set to the parent's ID."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecid",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecId"})]}),"\n",(0,r.jsx)(s.p,{children:"The ID of a WfSpec."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Name of the WfSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["Major Version of a WfSpec.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Note that WfSpec's are versioned. Creating a new WfSpec with the same name and no breaking changes to the public Variables API results in a new WfSpec being created with the same MajorVersion and a new revision. Creating a WfSpec with a breaking change to the public Variables API results in a new WfSpec being created with the same name, an incremented major_version, and revision = 0."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"revision"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["Revision of a WfSpec.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Note that WfSpec's are versioned. Creating a new WfSpec with the same name and no breaking changes to the public Variables API results in a new WfSpec being created with the same MajorVersion and a new revision. Creating a WfSpec with a breaking change to the public Variables API results in a new WfSpec being created with the same name, an incremented major_version, and revision = 0."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecmetricsid",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecMetricsId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a specific window of WfSpec metrics."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The timestamp at which this metrics window starts."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The length of this window."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The WfSpecId that this metrics window reports on."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"workfloweventdefid",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEventDefId"})]}),"\n",(0,r.jsx)(s.p,{children:"ID for a WorkflowEventDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the WorkflowEventDef"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"workfloweventid",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEventId"})]}),"\n",(0,r.jsx)(s.p,{children:"An ID for a WorkflowEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The Id of the WfRun that threw the event."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"workflow_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the WorkflowEventDef that this WorkflowEvent is a member of."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"A sequence number that makes the WorkflowEventId unique among all WorkflowEvent's of the same type thrown by the WfRun. This field starts at zero and is incremented every time a WorkflowEvent of the same type is thrown by the same WfRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"scheduledwfrun",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduledWfRun"})]}),"\n",(0,r.jsxs)(s.p,{children:["A ",(0,r.jsx)(s.code,{children:"ScheduledWfRun"})," is an object in the LittleHorse API that triggers a ",(0,r.jsx)(s.code,{children:"WfRun"})," to be started\non a cron schedule."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunid",children:"ScheduledWfRunId"})}),(0,r.jsx)(s.td,{children:"Unique id for this ScheduledWfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"WfSpec used to run a workflow on a schedule."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunvariablesentry",children:"ScheduledWfRun.VariablesEntry"})}),(0,r.jsx)(s.td,{children:"A map from Variable Name to Values for those variables. The provided variables are passed as input to the Entrypoint ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"Parent WfRunId associated with all the generated WfRuns"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"cron_expression"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"UNIX expression used to specify the schedule for executing WfRuns"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Creation time for this ScheduledWfRun"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"scheduledwfrunvariablesentry",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduledWfRun.VariablesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"awaitworkfloweventrequest",children:["Message ",(0,r.jsx)(s.code,{children:"AwaitWorkflowEventRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Request to await until a WorkflowEvent of a certain WorkflowEventDef on a certain WfRun\nis thrown. Relies upon native GRPC deadlines to configure timeouts."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfRun which must throw the WorkflowEvent."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"event_def_ids"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{children:"The IDs of the WorkflowEventDef that must be thrown. The request will return the first matching WorkflowEvent thrown. If event_def_ids is empty, then the request will return the first WorkflowEvent thrown by the WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"workflow_events_to_ignore"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventid",children:"WorkflowEventId"})}),(0,r.jsx)(s.td,{children:"Since a single WfRun may throw multiple WorkflowEvent's with the same WorkflowEventDefId, it is necessary to provide a client the ability to \"ignore\" WorkflowEvent's that have already been 'awaited'. Any WorkflowEvent specified by this field is ignored by the rpc."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteexternaleventdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteExternalEventDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes an ExternalEventDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEventDef to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteexternaleventrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteExternalEventRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes an ExternalEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEvent to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletescheduledwfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteScheduledWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Delete an existing ScheduledWfRun, returns INVALID_ARGUMENT if object does not exist"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunid",children:"ScheduledWfRunId"})}),(0,r.jsxs)(s.td,{children:["Id of the ",(0,r.jsx)(s.code,{children:"ScheduledWfRun"})," to be deleted"]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletetaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes a TaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the TaskDef to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteusertaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteUserTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes a UserTaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdefid",children:"UserTaskDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the UserTaskDef to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletewfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfRun to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deletewfspecrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteWfSpecRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes a WfSpec"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfSpec to delete"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"deleteworkfloweventdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"DeleteWorkflowEventDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Deletes an WorkflowEventDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the WorkflowEventDef to delete."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventdefidlist",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventDefIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of ExternalEventDef Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventidlist",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of ExternalEvent Id's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventlist",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of ExternalEvents."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externalevent",children:"ExternalEvent"})}),(0,r.jsx)(s.td,{children:"A list of ExternalEvent objects."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getlatestusertaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"GetLatestUserTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Returns the UserTaskDef with a given name and the highest version number."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the UserTaskDef to search for."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"getlatestwfspecrequest",children:["Message ",(0,r.jsx)(s.code,{children:"GetLatestWfSpecRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Get the latest WfSpec with a given name and optionally majorVersion"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the WfSpec to get. This is required."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally get only WfSpec's that have the same major version. This can be useful if you want to guarantee that there have been no breaking changes to the API of the WfSpec, for example, to ensure that there have been no changes to searchable variables or required input variables."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"lhhostinfo",children:["Message ",(0,r.jsx)(s.code,{children:"LHHostInfo"})]}),"\n",(0,r.jsx)(s.p,{children:"Information about a specific LH Server to contact."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"host"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The host on the server"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"port"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The port for the specified listener."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"listexternaleventsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListExternalEventsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List all ExternalEvents for a specific WfRunId. Note that List Requests return actual\nExternalEvent objects, not ExternalEventId's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRunId for whom we list ExternalEvent's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listnoderunsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListNodeRunsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List all NodeRun's for a given WfRun. Note that List requests return actual NodeRun Objects,\nnot NodeRunId's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRun for whom we list NodeRun's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally specify the thread run number to filter NodeRun's by."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"listtaskmetricsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListTaskMetricsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Query to retrieve TaskDef Metrics over a period of time."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"TaskDef id for whichwe retrieve metrics."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"last_window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["This parameter is a timestamp that is used to determine the ",(0,r.jsx)(s.em,{children:"last"})," window returned. The server will then return ",(0,r.jsx)(s.code,{children:"num_windows"})," worth of data from before this timestamp."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_length"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"Window size"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"num_windows"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Number of windows to retrieve."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"listtaskmetricsresponse",children:["Message ",(0,r.jsx)(s.code,{children:"ListTaskMetricsResponse"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of TaskDef Metrics WIndows"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefmetrics",children:"TaskDefMetrics"})}),(0,r.jsx)(s.td,{children:"List of TaskDef Metrics Windows"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listtaskrunsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListTaskRunsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List TaskRun's for a specific WfRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRun for which to list TaskRun's"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listusertaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListUserTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List UserTaskRun's for a specific WfRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRun for which to list UserTaskRuns"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listvariablesrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListVariablesRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List all Variables for a specific WfRun. Note that List requests return actual Variable Objects,\nnot VariableId's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRun for whom we will list Variables."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listwfmetricsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListWfMetricsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Query to retrieve WfSpec Metrics over a period of time."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"WfSpecId of metrics to get."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"last_window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["This parameter is a timestamp that is used to determine the ",(0,r.jsx)(s.em,{children:"last"})," window returned. The server will then return ",(0,r.jsx)(s.code,{children:"num_windows"})," worth of data from before this timestamp."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_length"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The window size"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"num_windows"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Number of windows to retrieve"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"listwfmetricsresponse",children:["Message ",(0,r.jsx)(s.code,{children:"ListWfMetricsResponse"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of WfSpec Metrics Windows"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecmetrics",children:"WfSpecMetrics"})}),(0,r.jsx)(s.td,{children:"List of WfSpec Metrics Windows"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"listworkfloweventsrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ListWorkflowEventsRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"List all WorkflowEvents for a specific WfRunId. Note that List Requests return actual\nWorkflowEvent objects, not WorkflowEventId's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The WfRunId for whom we list WorkflowEvent's."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"migratewfspecrequest",children:["Message ",(0,r.jsx)(s.code,{children:"MigrateWfSpecRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"EXPERIMENTAL: migrate live WfRun's from one version of a WfSpec to another."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"old_wf_spec"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"migration"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecversionmigration",children:"WfSpecVersionMigration"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"noderunidlist",children:["Message ",(0,r.jsx)(s.code,{children:"NodeRunIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of NodeRun Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"noderunlist",children:["Message ",(0,r.jsx)(s.code,{children:"NodeRunList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of NodeRun Objects."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderun",children:"NodeRun"})}),(0,r.jsx)(s.td,{children:"A list of NodeRun Objects."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"polltaskrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PollTaskRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Request sent by the Task Worker SDK to tell the Server that the Task Worker is ready\nto execute a TaskRun. Generally used only by the Task Worker SDK."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"Is the TaskDefId that the Task Worker wants to execute."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"client_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Is the ID of the Task Worker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_worker_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optionally specifies the version of the Task Worker, so that it can be recorded for debugging purposes on the TaskRun itself."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"polltaskresponse",children:["Message ",(0,r.jsx)(s.code,{children:"PollTaskResponse"})]}),"\n",(0,r.jsx)(s.p,{children:"Response from the server for PollTaskRequest."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"result"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledtask",children:"ScheduledTask"})}),(0,r.jsx)(s.td,{children:"If possible, a ScheduledTask is returned."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"principalidlist",children:["Message ",(0,r.jsx)(s.code,{children:"PrincipalIdList"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#principalid",children:"PrincipalId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putexternaleventdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutExternalEventDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Field to create an ExternalEventDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the resulting ExternalEventDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retention_policy"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventretentionpolicy",children:"ExternalEventRetentionPolicy"})}),(0,r.jsxs)(s.td,{children:["Policy to determine how long an ExternalEvent is retained after creation if it is not yet claimed by a WfRun. Note that once a WfRun has been matched with the ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted. If not set, then ExternalEvent's are not deleted if they are not matched with a WfRun.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"A future version of LittleHorse will allow changing the retention_policy, which will trigger a cleanup of old ",(0,r.jsx)(s.code,{children:"ExternalEvent"}),"s."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putexternaleventrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutExternalEventRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Request used to create an ExternalEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfRun that this Event is sent to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEventDef that this event implements."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"guid"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Note that an ExternalEventDefId is a three-part ID: 1. WfRunId 2. ExternalEventDef Name 3. A guid The guid from part 3) can be optionally provided to the PutExternalEventRequest in order to make it idempotent. It is a best practice to do so."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The content of this event."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally specify that this ExternalEvent may only be claimed by a specific ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_position"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally specify that this ExternalEvent may only be claimed by a specific NodeRun. In order for this to be set, you must also set thread_run_number."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"puttaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Creates a TaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the TaskDef to create."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"input_vars"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabledef",children:"VariableDef"})}),(0,r.jsx)(s.td,{children:"Variables required to execute the TaskDef. Normally, these are automatically generated by the Task Worker SDK."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"output_schema"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefoutputschema",children:"TaskDefOutputSchema"})}),(0,r.jsx)(s.td,{children:"Schema that validates the TaskDef's output"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putusertaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutUserTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Creates a UserTaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the UserTaskDef to create."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"fields"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskfield",children:"UserTaskField"})}),(0,r.jsx)(s.td,{children:"The fields that should be presented to the user on the screen in order to fill out the User Task. Note that these fields also define a data contract for the result of the UserTaskDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"description"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optional metadata field to store user-defined data. Does not impact workflow execution. Fine to store up to a few KB of text here."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putwfspecrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutWfSpecRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Creates a WfSpec. Generally, this request is generated by the Workflow object in\nour various SDK's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the resulting WfSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_specs"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#putwfspecrequestthreadspecsentry",children:"PutWfSpecRequest.ThreadSpecsEntry"})}),(0,r.jsx)(s.td,{children:"Map from name the ThreadSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"entrypoint_thread_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to be used as the workflow entrypoint."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retention_policy"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workflowretentionpolicy",children:"WorkflowRetentionPolicy"})}),(0,r.jsx)(s.td,{children:"Optional policy to determine how long a WfRun is retained in the data store after it is completed or terminated."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_spec"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecparentwfspecreference",children:"WfSpec.ParentWfSpecReference"})}),(0,r.jsxs)(s.td,{children:["Parent WfSpec Reference. If this is set, then all WfRun's for this WfSpec ",(0,r.jsx)(s.em,{children:"MUST"})," be Child WfRun's of the specified WfSpec."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"allowed_updates"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#allowedupdatetype",children:"AllowedUpdateType"})}),(0,r.jsx)(s.td,{children:"Configures the behavior of this individual request. Can be used to prevent breaking changes to the WfSpec, prevent any changes to the WfSpec, or allow all changes to the WfSpec."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putwfspecrequestthreadspecsentry",children:["Message ",(0,r.jsx)(s.code,{children:"PutWfSpecRequest.ThreadSpecsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadspec",children:"ThreadSpec"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"putworkfloweventdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"PutWorkflowEventDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Creates a WorkflowEventDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the resulting WorkflowEventDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabletype",children:"VariableType"})}),(0,r.jsx)(s.td,{children:"The type of 'content' thrown with a WorkflowEvent based on this WorkflowEventDef."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"registertaskworkerrequest",children:["Message ",(0,r.jsx)(s.code,{children:"RegisterTaskWorkerRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Message used by Task Worker to register itself to the server and ask for assignments of\nservers to poll."}),"\n",(0,r.jsx)(s.p,{children:"Used by the Task Worker SDK; generally, you shouldn't have to touch this manually."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_worker_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Is the ID of the Task Worker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The TaskDef the worker wants to poll for."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"registertaskworkerresponse",children:["Message ",(0,r.jsx)(s.code,{children:"RegisterTaskWorkerResponse"})]}),"\n",(0,r.jsx)(s.p,{children:"Response containing list of Servers that the Task Worker should connect to and start polling from.\nOnly used internally by the Task Worker SDK."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"your_hosts"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhhostinfo",children:"LHHostInfo"})}),(0,r.jsx)(s.td,{children:"The list of LH Server hosts that the Task Worker should start polling."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"is_cluster_healthy"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether the LH Cluster is healthy."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"reporttaskrun",children:["Message ",(0,r.jsx)(s.code,{children:"ReportTaskRun"})]}),"\n",(0,r.jsx)(s.p,{children:"Request used by the Task Worker SDK to report the result of a TaskRun execution."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:"ID of the TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"When the TaskRun was executed"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskstatus",children:"TaskStatus"})}),(0,r.jsx)(s.td,{children:"Status of the TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"log_output"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Optional information for logging or exceptions"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"attempt_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Attempt number of the TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"output"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Successfully completed task"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"error"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhtaskerror",children:"LHTaskError"})}),(0,r.jsx)(s.td,{children:"Technical error"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exception"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhtaskexception",children:"LHTaskException"})}),(0,r.jsx)(s.td,{children:"Business exception"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"rescuethreadrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"RescueThreadRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"The request used to rescue a failed ThreadRun at a specific NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsxs)(s.td,{children:["The id of the ",(0,r.jsx)(s.code,{children:"WfRun"})," which we are going to rescue."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The number of the failed ",(0,r.jsx)(s.code,{children:"ThreadRun"})," that we will rescue. The specified ",(0,r.jsx)(s.code,{children:"ThreadRun"})," must be in a state where it's latest ",(0,r.jsx)(s.code,{children:"NodeRun"})," is: ",(0,r.jsx)("br",{})," - In the ",(0,r.jsx)(s.code,{children:"ERROR"})," state.",(0,r.jsx)("br",{})," - Has no ",(0,r.jsx)(s.code,{children:"FailureHandler"})," ",(0,r.jsx)(s.code,{children:"ThreadRun"}),"s ",(0,r.jsx)("br",{})," - The parent ",(0,r.jsx)(s.code,{children:"ThreadRun"}),", or any parent of the parent, has not handled the ",(0,r.jsx)(s.code,{children:"Failure"})," yet.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If that is not true, then the ",(0,r.jsx)(s.code,{children:"ThreadRun"})," cannot be rescued and the request will return ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"skip_current_node"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsxs)(s.td,{children:["If set to ",(0,r.jsx)(s.code,{children:"true"}),", then the ThreadRun will skip past the ",(0,r.jsx)(s.code,{children:"Node"})," of the current failed ",(0,r.jsx)(s.code,{children:"NodeRun"})," and advance according to the outgoing edges. If set to ",(0,r.jsx)(s.code,{children:"false"}),", then the ",(0,r.jsx)(s.code,{children:"ThreadRun"})," will schedule another ",(0,r.jsx)(s.code,{children:"NodeRun"})," for the current ",(0,r.jsx)(s.code,{children:"Node"})]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"resumewfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ResumeWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Resume a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"Is the WfRunId"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The number of the ThreadRun to resume. Note that resuming the entrypoint ThreadRun (which always has number ",(0,r.jsx)(s.code,{children:"0"}),") causes the whole WfRun to resume. If you do not manually set the thread_run_number field, it defaults to zero, so resuming the entire WfRun is the default behavior."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"runwfrequest",children:["Message ",(0,r.jsx)(s.code,{children:"RunWfRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Create a Workflow Run."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the WfSpec to run."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:'Optionally specify the major version of the WfSpec to run. This guarantees that the "signature" of the WfSpec (i.e. the required input variables, and searchable variables) will not change for this app.'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"revision"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally specify the specific revision of the WfSpec to run. It is not recommended to use this in practice, as the WfSpec logic should be de-coupled from the applications that run WfRun's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#runwfrequestvariablesentry",children:"RunWfRequest.VariablesEntry"})}),(0,r.jsx)(s.td,{children:"A map from Variable Name to Values for those variables. The provided variables are passed as input to the Entrypoint ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"You can optionally specify the ID of this WfRun. This is a recommended best practice as it also makes your request idempotent and allows you to easily find the WfRun at a later time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"runwfrequestvariablesentry",children:["Message ",(0,r.jsx)(s.code,{children:"RunWfRequest.VariablesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"schedulewfrequest",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduleWfRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Schedule WfRuns based on a specific cron UNIX expression"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Specific ID"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the WfSpec to run."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:'Optionally specify the major version of the WfSpec to run. This guarantees that the "signature" of the WfSpec (i.e. the required input variables, and searchable variables) will not change for this app.'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"revision"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Optionally specify the specific revision of the WfSpec to run. It is not recommended to use this in practice, as the WfSpec logic should be de-coupled from the applications that run WfRun's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#schedulewfrequestvariablesentry",children:"ScheduleWfRequest.VariablesEntry"})}),(0,r.jsx)(s.td,{children:"A map from Variable Name to Values for those variables. The provided variables are passed as input to the Entrypoint ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_run_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"Parent WfRunId associated with all the generated WfRuns"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"cron_expression"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"UNIX expression used to specify the schedule for executing WfRuns"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"schedulewfrequestvariablesentry",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduleWfRequest.VariablesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"scheduledtask",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduledTask"})]}),"\n",(0,r.jsx)(s.p,{children:"Message sent by server to Task Worker SDK specifying a specific TaskRun to be executed.\nThis is used and handled internally by the Task Worker SDK."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:"Id of the TaskRun to execute."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"ID of the TaskDef to which the TaskRun belongs."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"attempt_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["Attempt number of the TaskRun, zero indexed. attempt_number of ",(0,r.jsx)(s.code,{children:"0"})," means this is the first attempt; ",(0,r.jsx)(s.code,{children:"1"})," means this is the first retry, etc."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#varnameandval",children:"VarNameAndVal"})}),(0,r.jsx)(s.td,{children:"Input variables for this TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"source"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunsource",children:"TaskRunSource"})}),(0,r.jsx)(s.td,{children:"Source of the TaskRun. Currently, there are two options: 1. A TASK node 2. A reminder task scheduled by a trigger on a User Task."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"scheduledwfrunidlist",children:["Message ",(0,r.jsx)(s.code,{children:"ScheduledWfRunIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of ScheduledWfRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#scheduledwfrunid",children:"ScheduledWfRunId"})}),(0,r.jsx)(s.td,{children:"A list of ScheduledWfRun Objects"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchexternaleventdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchExternalEventDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for ExternalEventDefs based on certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optionally search only for ExternalEventDef's whose name starts with this prefix."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchexternaleventrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchExternalEventRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for ExternalEvents based on certain criteria."}),"\n",(0,r.jsx)(s.p,{children:"Required field ExternalEventDefId specifies which ExternalEventDef\nto search for ExternalEvents under."}),"\n",(0,r.jsx)(s.p,{children:"At this time, it is not possible to make a search for all ExternalEvents."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only ExternalEvents created after this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only ExternalEvents created before this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsxs)(s.td,{children:["Search for ExternalEvents by their ExternalEventDefId",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"* Note: If ExternalEventDefId is not provided or does not exist, gRPC status code 'INVALID_ARGUMENT' will be returned."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"is_claimed"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Optionally search for only ExternalEvents that are claimed or not."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchnoderunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchNodeRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for NodeRun's by certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Only return NodeRun's created after this time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Only return NodeRun's created before this time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#searchnoderunrequestnodetype",children:"SearchNodeRunRequest.NodeType"})}),(0,r.jsx)(s.td,{children:"Specifies the type of NodeRun to search for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"Specifies the status of NodeRun to search for."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchprincipalrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchPrincipalRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for Principals based on certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only Principals's created after this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only Principals's created before this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"isAdmin"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"principal_criteria"})]}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"List only Principals that are admins"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"tenantId"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"principal_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"List Principals associated with this Tenant ID"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchscheduledwfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchScheduledWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search filters for ScheduledWfRun's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the WfSpec to filter"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The major version of the WfSpec to filter"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"revision"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The revision number of the WfSpec to filter"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for TaskDef's based on certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optionally specify to only return TaskDef's with a specific prefix."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Searches for TaskRuns by various criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Specifies the TaskDef of TaskRun's to return. This is required."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskstatus",children:"TaskStatus"})}),(0,r.jsx)(s.td,{children:"Specifies to only return TaskRun's matching this status."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to only return TaskRun's that were scheduled after this time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to only return TaskRun's that were scheduled before this time."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchtenantrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchTenantRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for all available TenantIds for current Principal"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchusertaskdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchUserTaskDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for UserTaskDef's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"user_task_def_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Return all UserTaskDef's with a specific prefix."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"user_task_def_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Return all UserTaskDef's with a specific name."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchusertaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchUserTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for UserTaskRun's matching certain criteria. The attributes are additive,\nyou may specify any combination of fields in this request. Only UserTaskRun's\nmatching all criteria will be returned."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunstatus",children:"UserTaskRunStatus"})}),(0,r.jsx)(s.td,{children:"Status of UserTaskRun's to return."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_def_name"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"UserTaskDef name to search for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Search for UserTaskRun's assigned to this user id."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Search for UserTaskRun's assigned to this user group."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Search for UserTaskRun's that were created after this time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Search for UserTaskRun's that were created before this time."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchvariablerequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchVariableRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for Variables by their value. This request is also highly useful to search for\nWfRun's based on the value of Variable's that are not in the Entrypoint ThreadRun,\nand also when you are using LittleHorse as a data store and need to perform a search."}),"\n",(0,r.jsxs)(s.p,{children:["You may only search for a Variable that has an index specified on it. This may be done\nvia th ",(0,r.jsx)(s.code,{children:".searchable()"})," method on our SDK's."]}),"\n",(0,r.jsx)(s.p,{children:"Note that we do not yet support searching JSON_OBJ or JSON_ARR fields, but you may\nstill mark those fields as searchable. We will soon add the ability to query those\nfields via the indices."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Specifies the value that the variable must be. Exact match is required."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Specifies major version of the WfSpec for the associated WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_revision"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Specifies the revision of the WfSpec for the associated WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"var_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Specifies the name of the variable to search for. This is required."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Specifies the name of the WfSpec for the associated WfRun's. This is required."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchwfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"A request used to retrieve a list of WfRunId's by certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The WfSpec whose WfRun's we are searching for. This is required."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_major_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Specifies to return only WfRun's from this WfSpec Major Version."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_revision"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Specifies to return only WfRun's from this WfSpec Revision. Can only be set if wf_spec_major_version is also set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"Specifies to return only WfRun's matching this status."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only WfRun's that started after this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only WfRun's that started before this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variable_filters"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablematch",children:"VariableMatch"})}),(0,r.jsx)(s.td,{children:"Allows filtering WfRun's based on the value of the Variables. This ONLY works for the Variables in the entrypiont threadrun (that is, variables where the threadRunNumber == 0)."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchwfspecrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchWfSpecRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for WfSpec's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"wf_spec_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Return WfSpec's with a specific name."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"wf_spec_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Return WfSpec's with a specific prefix."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_name"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"wf_spec_criteria"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Return all WfSpec's that make use of a given TaskDef."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchworkfloweventdefrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchWorkflowEventDefRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for WorkflowEventDefs based on certain criteria."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"prefix"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optionally search only for WorkflowEventDef's whose name starts with this prefix."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"searchworkfloweventrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SearchWorkflowEventRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Search for WorkflowEvents based on certain criteria."}),"\n",(0,r.jsx)(s.p,{children:"Required field WorkflowEventDefId specifies which WorkflowEventDef\nto search for WorkflowEvents under."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"limit"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Maximum results to return in one request."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"earliest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only WorkflowEvent created after this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_start"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Specifies to return only WorkflowEvent created before this time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"workflow_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsxs)(s.td,{children:["Search for WorkflowEvents by their WorkflowEventDefId",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"* Note: If WorkflowEventDefId is not provided or does not exist, gRPC status code 'INVALID_ARGUMENT' will be returned."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"serverversionresponse",children:["Message ",(0,r.jsx)(s.code,{children:"ServerVersionResponse"})]}),"\n",(0,r.jsx)(s.p,{children:"The version of the LH Server according to Semantic Versioning"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"major_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Server Major Version"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"minor_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Server Minor Version"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"patch_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Server Patch Version"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"pre_release_identifier"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Prerelease Identifier. If this is set, then the server is NOT a production release but rather a release candidate or experimental pre-release."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"stopwfrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"StopWfRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Message to HALT a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"Is the WfRunId"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The number of the ThreadRun to halt. Note that halting the entrypoint ThreadRun (which always has number ",(0,r.jsx)(s.code,{children:"0"}),") causes the whole WfRun to halt. If you do not manually set the thread_run_number field, it defaults to zero, so stopping the entire WfRun is the default behavior."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefidlist",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of TaskDef Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefmetrics",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefMetrics"})]}),"\n",(0,r.jsx)(s.p,{children:"Metrics for a TaskDef in a certain time period."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"TaskDef that the metrics apply to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"When the window started."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"Length of the window."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"schedule_to_start_max"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Longest time that a TaskRun was in the TASK_SCHEDULED state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"schedule_to_start_avg"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Average time that a TaskRun was in the TASK_SCHEDULED state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_to_complete_max"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Longest time between a TaskRun being started and completed"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_to_complete_avg"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Average time between a TaskRun being started and completed"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_completed"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of TaskRun's that reached the TASK_SUCCESS state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_errored"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of TaskRun's that reached the TASK_ERROR state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_started"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of TaskRun's that transitioned to the TASK_RUNNING state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_scheduled"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of TaskRun's that were scheduled"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefmetricsqueryrequest",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefMetricsQueryRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Query to retrieve a specific TaskDef Metrics Window."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["Return the window ",(0,r.jsx)(s.em,{children:"containing"})," this timestamp. The window start is not guaranteed to align perfectly with the request."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The window size"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_name"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the specific TaskDef for which we are calculating metrics."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskrunidlist",children:["Message ",(0,r.jsx)(s.code,{children:"TaskRunIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of TaskRun ID's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskrunlist",children:["Message ",(0,r.jsx)(s.code,{children:"TaskRunList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of TaskRun's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrun",children:"TaskRun"})}),(0,r.jsx)(s.td,{children:"A list of TaskRun Objects"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskworkergroup",children:["Message ",(0,r.jsx)(s.code,{children:"TaskWorkerGroup"})]}),"\n",(0,r.jsx)(s.p,{children:"Describes all workers registered for a specific TaskDef."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskworkergroupid",children:"TaskWorkerGroupId"})}),(0,r.jsx)(s.td,{children:"Identifier for the group."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Timestamp indicating when the worker group was initially registered."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_workers"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskworkergrouptaskworkersentry",children:"TaskWorkerGroup.TaskWorkersEntry"})}),(0,r.jsx)(s.td,{children:"Metadata grouped by ClientId string."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskworkergrouptaskworkersentry",children:["Message ",(0,r.jsx)(s.code,{children:"TaskWorkerGroup.TaskWorkersEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskworkermetadata",children:"TaskWorkerMetadata"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskworkerheartbeatrequest",children:["Message ",(0,r.jsx)(s.code,{children:"TaskWorkerHeartBeatRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Message used by Task Worker to register itself to the server and ask for assignments of\nservers to poll."}),"\n",(0,r.jsx)(s.p,{children:"Used by the Task Worker SDK; generally, you shouldn't have to touch this manually."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"client_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"listener_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskworkermetadata",children:["Message ",(0,r.jsx)(s.code,{children:"TaskWorkerMetadata"})]}),"\n",(0,r.jsx)(s.p,{children:"Describes a specific task worker"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_worker_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"User-defined identifier for the worker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"latest_heartbeat"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"Timestamp indicating the last heartbeat sent by the worker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"hosts"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhhostinfo",children:"LHHostInfo"})}),(0,r.jsx)(s.td,{children:"The host(s) where the worker is polling tasks"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"tenantidlist",children:["Message ",(0,r.jsx)(s.code,{children:"TenantIdList"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tenantid",children:"TenantId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"Bookmark for cursor-based pagination; pass if applicable."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskdefidlist",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskDefIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of UserTaskDef Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdefid",children:"UserTaskDefId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskrunidlist",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskRunIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of UserTaskRun Id's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskrunlist",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskRunList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of UserTaskRuns"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrun",children:"UserTaskRun"})}),(0,r.jsx)(s.td,{children:"A list of UserTaskRun Objects"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"variableidlist",children:["Message ",(0,r.jsx)(s.code,{children:"VariableIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"This is a list of Variable ID's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableid",children:"VariableId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variablelist",children:["Message ",(0,r.jsx)(s.code,{children:"VariableList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of Variables."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variable",children:"Variable"})}),(0,r.jsx)(s.td,{children:"A list of Variable objects."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"variablematch",children:["Message ",(0,r.jsx)(s.code,{children:"VariableMatch"})]}),"\n",(0,r.jsx)(s.p,{children:"Used by a SearchWfRunRequest to filter WfRun's and only return those whose Variable's\nmatch a certain filter."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"var_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the variable to inspect."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The value that the Variable must have in order to satisfy this VariableMatch"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfrunidlist",children:["Message ",(0,r.jsx)(s.code,{children:"WfRunIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of WfRun Id's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecidlist",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of WfSpec Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecmetrics",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecMetrics"})]}),"\n",(0,r.jsx)(s.p,{children:"Metrics for a WfSpec in a specific time window"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The WfSpecId that these metrics analyze"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time that the window started"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The length of the window"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_started"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of WfRun's created for this WfSpec"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_completed"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of WfRun's that reached the COMPLETED state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_errored"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Total number of WfRun's that reached the ERROR state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_to_complete_max"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Longest time between a WfRun being started and reaching the COMPLETED state"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_to_complete_avg"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Average time that a WfRun took to reach the COMPLETED state"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecmetricsqueryrequest",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecMetricsQueryRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Query to retrieve a specific WfSpec Metrics Window."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"WfSpecId of metrics to get."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_start"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["Return the window ",(0,r.jsx)(s.em,{children:"containing"})," this timestamp. The window start is not guaranteed to align perfectly with the request."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"window_length"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metricswindowlength",children:"MetricsWindowLength"})}),(0,r.jsx)(s.td,{children:"The window size"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"workfloweventdefidlist",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEventDefIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of WorkflowEventDef Id's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"workfloweventidlist",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEventIdList"})]}),"\n",(0,r.jsx)(s.p,{children:"List of WorkflowEvent Id's"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventid",children:"WorkflowEventId"})}),(0,r.jsx)(s.td,{children:"The resulting object id's."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bookmark"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"The bookmark can be used for cursor-based pagination. If it is null, the server has returned all results. If it is set, you can pass it into your next request to resume searching where your previous request left off."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"workfloweventlist",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEventList"})]}),"\n",(0,r.jsx)(s.p,{children:"A list of WorkflowEvents."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workflowevent",children:"WorkflowEvent"})}),(0,r.jsx)(s.td,{children:"A list of WorkflowEvent objects."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdef",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDef"})]}),"\n",(0,r.jsx)(s.p,{children:"A TaskDef defines a blueprint for a TaskRun that can be dispatched to Task Workers."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The ID of this TaskDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"input_vars"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabledef",children:"VariableDef"})}),(0,r.jsx)(s.td,{children:"The input variables required to execute this TaskDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time at which this TaskDef was created."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"schema_output"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefoutputschema",children:"TaskDefOutputSchema"})}),(0,r.jsx)(s.td,{children:"Schema that validates the TaskDef's output"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskdefoutputschema",children:["Message ",(0,r.jsx)(s.code,{children:"TaskDefOutputSchema"})]}),"\n",(0,r.jsx)(s.p,{children:"Schema that validates the TaskDef's output"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value_def"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabledef",children:"VariableDef"})}),(0,r.jsx)(s.td,{children:"The definition for the output content"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"lhtaskerror",children:["Message ",(0,r.jsx)(s.code,{children:"LHTaskError"})]}),"\n",(0,r.jsx)(s.p,{children:"Message denoting a TaskRun failed for technical reasons."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lherrortype",children:"LHErrorType"})}),(0,r.jsx)(s.td,{children:"The technical error code."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"message"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Human readable message for debugging."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"lhtaskexception",children:["Message ",(0,r.jsx)(s.code,{children:"LHTaskException"})]}),"\n",(0,r.jsx)(s.p,{children:"Message denoting a TaskRun's execution signaled that something went wrong in the\nbusiness process, throwing a littlehorse 'EXCEPTION'."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:'The user-defined Failure name, for example, "credit-card-declined"'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"message"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Human readadble description of the failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskattempt",children:["Message ",(0,r.jsx)(s.code,{children:"TaskAttempt"})]}),"\n",(0,r.jsx)(s.p,{children:"A single time that a TaskRun was scheduled for execution on a Task Queue."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"log_output"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsxs)(s.td,{children:["Optional information provided by the Task Worker SDK for debugging. Usually, if set it contains a stacktrace or it contains information logged via ",(0,r.jsx)(s.code,{children:"WorkerContext#log()"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"schedule_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the TaskAttempt was scheduled on the Task Queue. Not set for a TaskAttempt that is in the TASK_PENDING status; for example, when waiting between retries with exponential backoff."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the TaskAttempt was pulled off the queue and sent to a TaskWorker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"end_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the TaskAttempt was finished (either completed, reported as failed, or timed out)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_worker_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_worker_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The version of the Task Worker that executed the TaskAttempt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskstatus",children:"TaskStatus"})}),(0,r.jsx)(s.td,{children:"The status of this TaskAttempt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"output"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"Denotes the Task Function executed properly and returned an output."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"error"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhtaskerror",children:"LHTaskError"})}),(0,r.jsx)(s.td,{children:"An unexpected technical error was encountered. May or may not be retriable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exception"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"result"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhtaskexception",children:"LHTaskException"})}),(0,r.jsx)(s.td,{children:"The Task Function encountered a business problem and threw a technical exception."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"masked_value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Indicates whether the result of the attempt field has been masked"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"tasknodereference",children:["Message ",(0,r.jsx)(s.code,{children:"TaskNodeReference"})]}),"\n",(0,r.jsx)(s.p,{children:"Reference to a NodeRun of type TASK which caused a TaskRun to be scheduled."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the NodeRun which caused this TASK to be scheduled."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskrun",children:["Message ",(0,r.jsx)(s.code,{children:"TaskRun"})]}),"\n",(0,r.jsx)(s.p,{children:"A TaskRun resents a single instance of a TaskDef being executed."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the TaskRun. Note that the TaskRunId contains the WfRunId."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskdefid",children:"TaskDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the TaskDef being executed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"attempts"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskattempt",children:"TaskAttempt"})}),(0,r.jsx)(s.td,{children:"All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of the TaskRun being put on a Task Queue to be executed by the Task Workers."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"input_variables"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#varnameandval",children:"VarNameAndVal"})}),(0,r.jsx)(s.td,{children:"The input variables to pass into this TaskRun. Note that this is a list and not a map, because ordering matters. Depending on the language implementation, not every LittleHorse Task Worker SDK has the ability to determine the names of the variables from the method signature, so we provide both names and ordering."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"source"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunsource",children:"TaskRunSource"})}),(0,r.jsx)(s.td,{children:"The source (in the WfRun) that caused this TaskRun to be created. Currently, this can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such as a task used to send reminders)."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"scheduled_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"When the TaskRun was scheduled."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskstatus",children:"TaskStatus"})}),(0,r.jsx)(s.td,{children:"The status of the TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"timeout_seconds"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The timeout before LH considers a TaskAttempt to be timed out."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"total_attempts"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The maximum number of attempts that may be scheduled for this TaskRun. NOTE: setting total_attempts to 1 means that there are no retries."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exponential_backoff"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#exponentialbackoffretrypolicy",children:"ExponentialBackoffRetryPolicy"})}),(0,r.jsx)(s.td,{children:"Optional backoff policy ."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"taskrunsource",children:["Message ",(0,r.jsx)(s.code,{children:"TaskRunSource"})]}),"\n",(0,r.jsx)(s.p,{children:"The source of a TaskRun; i.e. why it was scheduled."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_node"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"task_run_source"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tasknodereference",children:"TaskNodeReference"})}),(0,r.jsx)(s.td,{children:"Reference to a NodeRun of type TASK which scheduled this TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_trigger"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"task_run_source"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertasktriggerreference",children:"UserTaskTriggerReference"})}),(0,r.jsx)(s.td,{children:"Reference to the specific UserTaskRun trigger action which scheduled this TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so that the WorkerContext can know this information."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"varnameandval",children:["Message ",(0,r.jsx)(s.code,{children:"VarNameAndVal"})]}),"\n",(0,r.jsx)(s.p,{children:"A key-value pair of variable name and value."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"var_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The variable name."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The value of the variable for this TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"masked"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsxs)(s.td,{children:["Indicates whether the content of the ",(0,r.jsx)(s.code,{children:"value"})," field has been masked"]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"assignusertaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"AssignUserTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Re-Assigns a UserTaskRun to a specific userId or userGroup."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The UserTaskRun to assign to a new user_id or user_group."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"override_claim"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"If override_claim is set to false and the UserTaskRun is already assigned to a user_id, then the request throws a FAILED_PRECONDITION error. If set to true, then the old claim is overriden and the UserTaskRun is assigned to the new user."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The new user_group to which the UserTaskRun is assigned. If not set, then the user_group of the UserTaskRun is actively unset by this request. At least one of the user_group and user_id must be set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The new user_id to which the UserTaskRun is assigned. If not set, then the user_id of the UserTaskRun is actively unset by this request. At least one of the user_group and user_id must be set."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"cancelusertaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"CancelUserTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Cancels a UserTaskRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The id of the UserTaskRun to cancel."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"completeusertaskrunrequest",children:["Message ",(0,r.jsx)(s.code,{children:"CompleteUserTaskRunRequest"})]}),"\n",(0,r.jsx)(s.p,{children:"Completes a UserTaskRun with provided values."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The id of UserTaskRun to complete."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#completeusertaskrunrequestresultsentry",children:"CompleteUserTaskRunRequest.ResultsEntry"})}),(0,r.jsx)(s.td,{children:"A map from UserTaskField.name to a VariableValue containing the results of the user filling out the form."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The ID of the user who executed the task."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"completeusertaskrunrequestresultsentry",children:["Message ",(0,r.jsx)(s.code,{children:"CompleteUserTaskRunRequest.ResultsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"saveusertaskrunprogressrequest",children:["Message ",(0,r.jsx)(s.code,{children:"SaveUserTaskRunProgressRequest"})]}),"\n",(0,r.jsxs)(s.p,{children:["Saves the results of a UserTaskRun and logs who saved the content.",(0,r.jsx)("br",{})]}),"\n",(0,r.jsxs)("li",{children:[" Throws FAILED_PRECONDITION if the UserTaskRun is in the ",(0,r.jsx)(s.code,{children:"DONE"})," or ",(0,r.jsx)(s.code,{children:"CANCELLED"})," state."]}),"\n",(0,r.jsxs)("li",{children:[" If ",(0,r.jsx)(s.code,{children:"policy"})," is set to ",(0,r.jsx)(s.code,{children:"FAIL_IF_CLAIMED_BY_OTHER"}),", returns ",(0,r.jsx)(s.code,{children:"FAILED_PRECONDITION"})," if the\n",(0,r.jsx)(s.code,{children:"user_id"})," field of the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," does not match the ",(0,r.jsx)(s.code,{children:"user_id"})," of the request."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The id of UserTaskRun to save."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#saveusertaskrunprogressrequestresultsentry",children:"SaveUserTaskRunProgressRequest.ResultsEntry"})}),(0,r.jsx)(s.td,{children:"A map from UserTaskField.name to a VariableValue containing the results of the user filling out the form."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The ID of the user who saved the task."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"policy"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#saveusertaskrunprogressrequestsaveusertaskrunassignmentpolicy",children:"SaveUserTaskRunProgressRequest.SaveUserTaskRunAssignmentPolicy"})}),(0,r.jsxs)(s.td,{children:["Configures how to handle ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," ownership when saving it."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"saveusertaskrunprogressrequestresultsentry",children:["Message ",(0,r.jsx)(s.code,{children:"SaveUserTaskRunProgressRequest.ResultsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskdef",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskDef"})]}),"\n",(0,r.jsx)(s.p,{children:"UserTaskDef is the metadata blueprint for UserTaskRuns."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["The name of the ",(0,r.jsx)(s.code,{children:"UserTaskDef"})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The version of the ",(0,r.jsx)(s.code,{children:"UserTaskDef"}),". Only simple versioning is supported."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"description"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Metadata field that does not impact WfRun execution. Useful for providing context on the UserTaskRun, for example when displaying it on a general-purpose task manager application."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"fields"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskfield",children:"UserTaskField"})}),(0,r.jsx)(s.td,{children:"These are the fields comprise the User Task. A User Task Manager application, or any application used to complete a UserTaskRun, should inspect these fields and display form entries for each one."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the UserTaskRun was created."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskevent",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent"})]}),"\n",(0,r.jsxs)(s.p,{children:["This is an event stored in the audit log of a ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," purely for observability\npurposes."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"the time the event occurred."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_executed"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"event"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskeventutetaskexecuted",children:"UserTaskEvent.UTETaskExecuted"})}),(0,r.jsx)(s.td,{children:"Denotes that a TaskRun was scheduled via a trigger."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"assigned"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"event"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskeventuteassigned",children:"UserTaskEvent.UTEAssigned"})}),(0,r.jsx)(s.td,{children:"Denotes that the UserTaskRun was assigned."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"cancelled"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"event"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskeventutecancelled",children:"UserTaskEvent.UTECancelled"})}),(0,r.jsx)(s.td,{children:"Denotes that the UserTaskRun was cancelled."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"saved"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"event"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskeventutesaved",children:"UserTaskEvent.UTESaved"})}),(0,r.jsxs)(s.td,{children:["Denotes that the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," was saved."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskeventuteassigned",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent.UTEAssigned"})]}),"\n",(0,r.jsx)(s.p,{children:"Message denoting that the UserTaskRun was assigned."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"old_user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The user_id before the ownership change, if set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"old_user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The user_group before the ownership change, if set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The user_id after the ownership change, if set."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The user_group after the ownership change, if set."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskeventutecancelled",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent.UTECancelled"})]}),"\n",(0,r.jsxs)(s.p,{children:["Empty message used to denote that the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," was cancelled."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"message"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskeventutesaved",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent.UTESaved"})]}),"\n",(0,r.jsxs)(s.p,{children:["Message to denote that the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," was saved."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The user_id of the user who saved the UserTaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskeventutesavedresultsentry",children:"UserTaskEvent.UTESaved.ResultsEntry"})}),(0,r.jsx)(s.td,{children:"The results that were saved."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskeventutesavedresultsentry",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent.UTESaved.ResultsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskeventutetaskexecuted",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskEvent.UTETaskExecuted"})]}),"\n",(0,r.jsxs)(s.p,{children:["Message to denote that a ",(0,r.jsx)(s.code,{children:"TaskRun"})," was scheduled by a trigger for this UserTaskRun."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task_run"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#taskrunid",children:"TaskRunId"})}),(0,r.jsxs)(s.td,{children:["The ",(0,r.jsx)(s.code,{children:"TaskRunId"})," of the scheduled ",(0,r.jsx)(s.code,{children:"TaskRun"})]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskfield",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskField"})]}),"\n",(0,r.jsx)(s.p,{children:"A UserTaskField is a specific field of data to be entered into a UserTaskRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the field. When a UserTaskRun is completed, the NodeOutput is a single-level JSON_OBJ. Each key is the name of the field. Must be unique."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabletype",children:"VariableType"})}),(0,r.jsx)(s.td,{children:"The type of the output. Must be a primitive type (STR, BOOL, INT, DOUBLE)."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"description"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Optional description which can be displayed by the User Task UI application. Does not affect WfRun execution."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"display_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name to be displayed by the User Task UI application. Does not affect WfRun execution."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"required"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether this field is required for UserTaskRun completion."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskrun",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskRun"})]}),"\n",(0,r.jsxs)(s.p,{children:["A UserTaskRun is a running instance of a UserTaskDef. It is created when a\nThreadRun arrives at a Node of type ",(0,r.jsx)(s.code,{children:"USER_TASK"}),"."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunid",children:"UserTaskRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the UserTaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskdefid",children:"UserTaskDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the UserTaskDef that this UserTaskRun comes from."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["Denotes the UserTaskRun as belonging to a specific User Group.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"The ",(0,r.jsx)(s.code,{children:"user_group"})," does not refer to a group that is stored in LittleHorse; rather, it is the responsibility of the application to keep track of user/group identity and ensure that the user_group does indeed exist.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Either ",(0,r.jsx)(s.code,{children:"user_id"})," or ",(0,r.jsx)(s.code,{children:"user_group"})," or both are set at any time."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["Denotes the UserTaskRun as assigned to a specific User ID. If this is set, then the UserTaskRun is either in the ASSIGNED, DONE, or CANCELLED status.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"The ",(0,r.jsx)(s.code,{children:"user_id"})," does not refer to a User that is stored in LittleHorse; rather, it is the responsibility of the application to keep track of user identity and ensure that the user_id does indeed exist.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Either ",(0,r.jsx)(s.code,{children:"user_id"})," or ",(0,r.jsx)(s.code,{children:"user_group"})," or both are set at any time."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"results"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunresultsentry",children:"UserTaskRun.ResultsEntry"})}),(0,r.jsxs)(s.td,{children:["The results of the UserTaskRun. Empty if the UserTaskRun has not yet been completed. Each key in this map is the ",(0,r.jsx)(s.code,{children:"name"})," of a corresponding ",(0,r.jsx)(s.code,{children:"UserTaskField"})," on the UserTaskDef."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskrunstatus",children:"UserTaskRunStatus"})}),(0,r.jsx)(s.td,{children:"Status of the UserTaskRun. Can be UNASSIGNED, ASSIGNED, DONE, or CANCELLED."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"events"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertaskevent",children:"UserTaskEvent"})}),(0,r.jsx)(s.td,{children:"A list of events that have happened. Used for auditing information."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"notes"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["Notes about this UserTaskRun that are ",(0,r.jsx)(s.strong,{children:"specific to the WfRun"}),". These notes are set by the WfSpec based on variables inside the specific ",(0,r.jsx)(s.code,{children:"WfRun"})," and are intended to be displayed on the User Task Manager application. They do not affect WfRun execution."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"scheduled_time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time that the UserTaskRun was created/scheduled."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:"The NodeRun with which the UserTaskRun is associated."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"epoch"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Current observed epoch of the UserTaskRun, related to the number of times it has been updated or re-assigned. Used internally to implement automated reassignment and reminder tasks."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertaskrunresultsentry",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskRun.ResultsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertasktriggerreference",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskTriggerReference"})]}),"\n",(0,r.jsx)(s.p,{children:'All TaskRun\'s have a "trigger reference" which refers to the WfRun Element that\ncaused the TaskRun to be scheduled. For example, a TaskRun on a regular TASK_NODE\nhas a TaskNodeReference.'}),"\n",(0,r.jsx)(s.p,{children:'The UserTaskTriggerReference serves as the "Trigger Reference" for a TaskRun that\nwas scheduled by a lifecycle hook on a UserTaskRun (eg. a reminder task).'}),"\n",(0,r.jsx)(s.p,{children:"The UserTaskTriggerReference is most useful in the WorkerContext of the Task Worker\nSDK, which allows the Task Method to determine where the TaskRun comes from."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#noderunid",children:"NodeRunId"})}),(0,r.jsx)(s.td,{children:"Is the NodeRun that the UserTaskRun belongs to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_event_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["Is the index in the ",(0,r.jsx)(s.code,{children:"events"})," field of the UserTaskRun that the TaskRun corresponds to."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Is the user_id that the UserTaskRun is assigned to. Unset if UserTaskRun is not asigned to a specific user_id."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Is the user_id that the UserTaskRun is assigned to. Unset if UserTaskRun is not asigned to a specific user_id."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variable",children:["Message ",(0,r.jsx)(s.code,{children:"Variable"})]}),"\n",(0,r.jsx)(s.p,{children:"A Variable is an instance of a variable assigned to a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableid",children:"VariableId"})}),(0,r.jsx)(s.td,{children:"ID of this Variable. Note that the VariableId contains the relevant WfRunId inside it, the threadRunNumber, and the name of the Variabe."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The value of this Variable."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"When the Variable was created."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfSpec that this Variable belongs to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"masked"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Marks a variable to show masked values"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"variablevalue",children:["Message ",(0,r.jsx)(s.code,{children:"VariableValue"})]}),"\n",(0,r.jsx)(s.p,{children:"VariableValue is a structure containing a value in LittleHorse. It can be\nused to pass input variables into a WfRun/ThreadRun/TaskRun/etc, as output\nfrom a TaskRun, as the value of a WfRun's Variable, etc."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"json_obj"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"A String representing a serialized json object."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"json_arr"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"A String representing a serialized json list."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"double"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"double"}),(0,r.jsx)(s.td,{children:"A 64-bit floating point number."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bool"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"A boolean."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"str"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"A string."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"int"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsxs)(s.td,{children:["The ",(0,r.jsx)(s.code,{children:"INT"})," variable type is stored as a 64-bit integer. The ",(0,r.jsx)(s.code,{children:"INT"})," can be cast to a ",(0,r.jsx)(s.code,{children:"DOUBLE"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"bytes"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"value"})]}),(0,r.jsx)(s.td,{children:"bytes"}),(0,r.jsx)(s.td,{children:"An arbitrary String of bytes."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"failurebeinghandled",children:["Message ",(0,r.jsx)(s.code,{children:"FailureBeingHandled"})]}),"\n",(0,r.jsx)(s.p,{children:"Points to the Failure that is currently being handled in the ThreadRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The thread run number."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_position"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The position of the NodeRun causing the failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The number of the failure."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"handlingfailurehaltreason",children:["Message ",(0,r.jsx)(s.code,{children:"HandlingFailureHaltReason"})]}),"\n",(0,r.jsx)(s.p,{children:"A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is being run."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handler_thread_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The ID of the Failure Handler ThreadRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"interrupted",children:["Message ",(0,r.jsx)(s.code,{children:"Interrupted"})]}),"\n",(0,r.jsx)(s.p,{children:"A Halt Reason denoting that a ThreadRun is halted because it is waiting for the\ninterrupt handler threadRun to run."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"interrupt_thread_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The ID of the Interrupt Handler ThreadRun."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"manualhalt",children:["Message ",(0,r.jsx)(s.code,{children:"ManualHalt"})]}),"\n",(0,r.jsxs)(s.p,{children:["A Halt Reason denoting that a ThreadRun was halted manually, via the ",(0,r.jsx)(s.code,{children:"rpc StopWfRun"})," request."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"meaning_of_life"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Nothing to store."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"parenthalted",children:["Message ",(0,r.jsx)(s.code,{children:"ParentHalted"})]}),"\n",(0,r.jsx)(s.p,{children:"A Halt Reason denoting that a ThreadRun is halted because its parent is also HALTED."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_thread_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The ID of the halted parent."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"pendingfailurehandler",children:["Message ",(0,r.jsx)(s.code,{children:"PendingFailureHandler"})]}),"\n",(0,r.jsx)(s.p,{children:"Represents a Failure Handler that is pending to be run."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failed_thread_run"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The ThreadRun that failed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handler_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to run to handle the failure."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"pendingfailurehandlerhaltreason",children:["Message ",(0,r.jsx)(s.code,{children:"PendingFailureHandlerHaltReason"})]}),"\n",(0,r.jsxs)(s.p,{children:["A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is ",(0,r.jsx)(s.em,{children:"enqueued"})," to be\nrun."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_run_position"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The position of the NodeRun which threw the failure."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"pendinginterrupt",children:["Message ",(0,r.jsx)(s.code,{children:"PendingInterrupt"})]}),"\n",(0,r.jsx)(s.p,{children:"Represents an ExternalEvent that has a registered Interrupt Handler for it\nand which is pending to be sent to the relevant ThreadRun's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEvent triggering the Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handler_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to run to handle the Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"interrupted_thread_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The ID of the ThreadRun to interrupt. Must wait for this ThreadRun to be HALTED before running the Interrupt Handler."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"pendinginterrupthaltreason",children:["Message ",(0,r.jsx)(s.code,{children:"PendingInterruptHaltReason"})]}),"\n",(0,r.jsx)(s.p,{children:"A Halt Reason denoting that a ThreadRun is halted while waiting for an Interrupt handler\nto be run."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"The ExternalEventId that caused the Interrupt."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadhaltreason",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadHaltReason"})]}),"\n",(0,r.jsxs)(s.p,{children:["Denotes a reason why a ThreadRun is halted. See ",(0,r.jsx)(s.code,{children:"ThreadRun.halt_reasons"})," for context."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_halted"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#parenthalted",children:"ParentHalted"})}),(0,r.jsx)(s.td,{children:"Parent threadRun halted."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"interrupted"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#interrupted",children:"Interrupted"})}),(0,r.jsx)(s.td,{children:"Handling an Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"pending_interrupt"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#pendinginterrupthaltreason",children:"PendingInterruptHaltReason"})}),(0,r.jsx)(s.td,{children:"Waiting to handle Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"pending_failure"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#pendingfailurehandlerhaltreason",children:"PendingFailureHandlerHaltReason"})}),(0,r.jsx)(s.td,{children:"Waiting to handle a failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handling_failure"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#handlingfailurehaltreason",children:"HandlingFailureHaltReason"})}),(0,r.jsx)(s.td,{children:"Handling a failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"manual_halt"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"reason"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#manualhalt",children:"ManualHalt"})}),(0,r.jsx)(s.td,{children:"Manually stopped the WfRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadrun",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadRun"})]}),"\n",(0,r.jsx)(s.p,{children:"A ThreadRun is a running thread of execution within a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The current WfSpecId of this ThreadRun. This must be set explicitly because during a WfSpec Version Migration, it is possible for different ThreadSpec's to have different WfSpec versions."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The number of the ThreadRun. This is an auto-incremented integer corresponding to the chronological ordering of when the ThreadRun's were created. If you have not configured any retention policy for the ThreadRun's (i.e. never clean them up), then this also corresponds to the position of the ThreadRun in the WfRun's ",(0,r.jsx)(s.code,{children:"thread_runs"})," list."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"The status of the ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec being run."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the ThreadRun was started."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"end_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the ThreadRun was completed or failed. Unset if still active."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"error_message"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Human-readable error message detailing what went wrong in the case of a failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"child_thread_ids"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"List of thread_run_number's for all child thread_runs."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_thread_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"halt_reasons"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadhaltreason",children:"ThreadHaltReason"})}),(0,r.jsx)(s.td,{children:'If the ThreadRun is HALTED, this contains a list of every reason for which the ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list), then the ThreadRun will return to the RUNNING state.'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"interrupt_trigger_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventid",children:"ExternalEventId"})}),(0,r.jsx)(s.td,{children:"If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the ExternalEvent that caused the Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_being_handled"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failurebeinghandled",children:"FailureBeingHandled"})}),(0,r.jsx)(s.td,{children:"If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure that is being handled by this ThreadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"current_node_position"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["This is the current ",(0,r.jsx)(s.code,{children:"position"})," of the current NodeRun being run. This is an auto-incremented field that gets incremented every time we run a new NodeRun."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handled_failed_children"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["List of every child ThreadRun which both a) failed, and b) was properly handled by a Failure Handler.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),'This is important because at the EXIT node, if a Child ThreadRun was discovered to have failed, then this ThreadRun (the parent) also fails with the same failure as the child. If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun\'s number is appended to this list, and then the EXIT node ignores that ThreadRun.']})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadtype",children:"ThreadType"})}),(0,r.jsx)(s.td,{children:"The Type of this ThreadRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfrun",children:["Message ",(0,r.jsx)(s.code,{children:"WfRun"})]}),"\n",(0,r.jsx)(s.p,{children:"A WfRun is a running instance of a WfSpec."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunid",children:"WfRunId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"The ID of the WfSpec that this WfRun belongs to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"old_wf_spec_versions"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsx)(s.td,{children:"When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the old WfSpecId to this list for historical auditing and debugging purposes."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#lhstatus",children:"LHStatus"})}),(0,r.jsx)(s.td,{children:"The status of this WfRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"greatest_threadrun_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsxs)(s.td,{children:["The ID number of the greatest ThreadRUn in this WfRun. The total number of ThreadRuns is given by greatest_thread_run_number + 1.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Introduced now since with ThreadRun-level retention, we can't rely upon thread_runs.size() to determine the number of ThreadRuns, as a ThreadRun is removed from the thread_runs list once its retention period expires."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_time"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the WfRun was started."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"end_time"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time the WfRun failed or completed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_runs"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadrun",children:"ThreadRun"})}),(0,r.jsx)(s.td,{children:"A list of all active ThreadRun's and terminated ThreadRun's whose retention periods have not yet expired."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"pending_interrupts"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#pendinginterrupt",children:"PendingInterrupt"})}),(0,r.jsx)(s.td,{children:"A list of Interrupt events that will fire once their appropriate ThreadRun's finish halting."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"pending_failures"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#pendingfailurehandler",children:"PendingFailureHandler"})}),(0,r.jsx)(s.td,{children:"A list of pending failure handlers which will fire once their appropriate ThreadRun's finish halting."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"edge",children:["Message ",(0,r.jsx)(s.code,{children:"Edge"})]}),"\n",(0,r.jsx)(s.p,{children:"The Edge is the line in the workflow that connects one Node to another."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"sink_node_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the Node that the Edge points to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"condition"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#edgecondition",children:"EdgeCondition"})}),(0,r.jsxs)(s.td,{children:["The Condition on which this Edge will be traversed. When choosing an Edge to travel after the completion of a NodeRun, the Edges are evaluated in order. The first one to either have no condition or have a condition which evaluates to ",(0,r.jsx)(s.code,{children:"true"})," is taken."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variable_mutations"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablemutation",children:"VariableMutation"})}),(0,r.jsx)(s.td,{children:"Ordered list of Variable Mutations to execute when traversing this Edge."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"edgecondition",children:["Message ",(0,r.jsx)(s.code,{children:"EdgeCondition"})]}),"\n",(0,r.jsx)(s.p,{children:"This is a boolean expression used to evaluate whether an Edge is valid."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"comparator"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#comparator",children:"Comparator"})}),(0,r.jsx)(s.td,{children:"The Operator used to evaluate the left versus the right."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"left"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"The left side of the boolean expression."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"right"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"The right side of the Boolean Expression."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"entrypointnode",children:["Message ",(0,r.jsx)(s.code,{children:"EntrypointNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines the beginning of the ThreadRun execution."}),"\n",(0,r.jsx)(s.p,{children:"Output is NULL"}),"\n",(0,r.jsxs)(s.h3,{id:"exitnode",children:["Message ",(0,r.jsx)(s.code,{children:"ExitNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines the end of the ThreadRun execution."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_def"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failuredef",children:"FailureDef"})}),(0,r.jsxs)(s.td,{children:["If set, this ExitNode throws the specified Failure upon arrival. Note that Failures are propagated up to the parent ThreadRun (or cause the entire WfRun to fail if sent by the entrypoint ThreadRun).",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If this is not set, then a ThreadRun arriving at this Exit Node will be COMPLETED."]})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"externaleventnode",children:["Message ",(0,r.jsx)(s.code,{children:"ExternalEventNode"})]}),"\n",(0,r.jsx)(s.p,{children:"An ExternalEventNode causes the WfRun to stop and wait for an ExternalEvent\nto arrive before continuing onwards."}),"\n",(0,r.jsx)(s.p,{children:"The output is just the content of the ExternalEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEventDef that we are waiting for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"timeout_seconds"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Determines the maximum amount of time that the NodeRun will wait for the ExternalEvent to arrive."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"failuredef",children:["Message ",(0,r.jsx)(s.code,{children:"FailureDef"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines a Failure that can be thrown."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The code for the failure. If in UPPER_CASE, it must be one of the LHErrorType enums, and represents an ERROR. If it is in kebab-case, then it is a user-defined EXCEPTION."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"message"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Human-readable message denoting why the Failure occurred."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"If specified, the thrown Failure will have this content."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"failurehandlerdef",children:["Message ",(0,r.jsx)(s.code,{children:"FailureHandlerDef"})]}),"\n",(0,r.jsx)(s.p,{children:"Specifies a Failure Handler which can run in case of a certain Failure to allow\nthe ThreadRun to run compensatory logic and gracefully continue rather than\nfailing immediately."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handler_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to run as a"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"specific_failure"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"failure_to_catch"})]}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["Specifies that this FailureHandlerDef will be triggered for a Failure with this exact name.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"If this and ",(0,r.jsx)(s.code,{children:"specific_failure"})," are both unset, then any failure is caught."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"any_failure_of_type"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"failure_to_catch"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failurehandlerdeflhfailuretype",children:"FailureHandlerDef.LHFailureType"})}),(0,r.jsx)(s.td,{children:"Specifies that this FailureHandlerDef will be triggered for any failure matching this type (ERROR or EXCEPTION)."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"interruptdef",children:["Message ",(0,r.jsx)(s.code,{children:"InterruptDef"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines an Interrupt for a ThreadSpec. An Interrupt means that when an ExternalEvent\nof a certain type is registered to the WfRun, then the affected ThreadRun is HALTED\nand a handler ThreadRun is run as an interrupt handler. The interrupted ThreadRun\nis resumed once the interrupt handler completes."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventdefid",children:"ExternalEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the ExternalEventDef which triggers an Interrupt for this ThreadSpec. Note that as of 0.9.0, you cannot use an ExternalEventDefId for both an InterruptDef and an ExternalEventNode in the same WfSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"handler_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec that we run as the interrupt handler."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"jsonindex",children:["Message ",(0,r.jsx)(s.code,{children:"JsonIndex"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines an index to make a JSON_OBJ or JSON_ARR variable searchable over a specific\nJSON Path."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"field_path"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Denotes the path in JSONPath format (according to the Java Jayway library) that has a field we should index."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"field_type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabletype",children:"VariableType"})}),(0,r.jsx)(s.td,{children:"Is the type of the field we are indexing."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"node",children:["Message ",(0,r.jsx)(s.code,{children:"Node"})]}),"\n",(0,r.jsx)(s.p,{children:"A Node is a step in a ThreadRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"outgoing_edges"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#edge",children:"Edge"})}),(0,r.jsx)(s.td,{children:"Defines the flow of execution and determines where the ThreadRun goes next."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"failure_handlers"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failurehandlerdef",children:"FailureHandlerDef"})}),(0,r.jsx)(s.td,{children:"Specifies handlers for failures (EXCEPTION or ERROR or both) which might be thrown by the NodeRun. If a Failure is thrown by the Node execution, then the first matching Failure Handler (if present) is run. If there is a matching Failure Handler and it runs to completion, then the ThreadRun advances from the Node; else, it fails."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"entrypoint"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#entrypointnode",children:"EntrypointNode"})}),(0,r.jsx)(s.td,{children:"Creates an EntrypointRun. Every ThreadRun has one Entrypoint node."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"exit"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#exitnode",children:"ExitNode"})}),(0,r.jsx)(s.td,{children:"Creates an `ExitRun``. Every ThreadSpec has at least one Exit Node."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#tasknode",children:"TaskNode"})}),(0,r.jsx)(s.td,{children:"Creates a TaskNodeRUn"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"external_event"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#externaleventnode",children:"ExternalEventNode"})}),(0,r.jsx)(s.td,{children:"Creates an ExternalEventNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_thread"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startthreadnode",children:"StartThreadNode"})}),(0,r.jsx)(s.td,{children:"Creates a StartThreadNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wait_for_threads"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsnode",children:"WaitForThreadsNode"})}),(0,r.jsx)(s.td,{children:"Creates a WaitForThreadsNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"nop"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#nopnode",children:"NopNode"})}),(0,r.jsx)(s.td,{children:"Creates a NopNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"sleep"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#sleepnode",children:"SleepNode"})}),(0,r.jsx)(s.td,{children:"Creates a SleepNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#usertasknode",children:"UserTaskNode"})}),(0,r.jsx)(s.td,{children:"Creates a UserTaskNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"start_multiple_threads"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startmultiplethreadsnode",children:"StartMultipleThreadsNode"})}),(0,r.jsx)(s.td,{children:"Creates a StartMultipleThreadsNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"throw_event"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#throweventnode",children:"ThrowEventNode"})}),(0,r.jsx)(s.td,{children:"Creates a ThrowEventNodeRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wait_for_condition"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"node"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforconditionnode",children:"WaitForConditionNode"})}),(0,r.jsx)(s.td,{children:"Creates a WaitForConditionRun"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"nodemigration",children:["Message ",(0,r.jsx)(s.code,{children:"NodeMigration"})]}),"\n",(0,r.jsx)(s.p,{children:"EXPERIMENTAL: Specification for migrating a WfRun from a Node in one WfSpec\nto a Node in another WfSpec version."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_node_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the Node on the new WfSpec to move to."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"nopnode",children:["Message ",(0,r.jsx)(s.code,{children:"NopNode"})]}),"\n",(0,r.jsx)(s.p,{children:"NOP node has no operations and is used for conditional branching."}),"\n",(0,r.jsxs)(s.h3,{id:"sleepnode",children:["Message ",(0,r.jsx)(s.code,{children:"SleepNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Sleep Node causes the WfRun to wait a specified time and then resume."}),"\n",(0,r.jsx)(s.p,{children:"There is no output."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"raw_seconds"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"sleep_length"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Sleeps the specified number of seconds."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"timestamp"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"sleep_length"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsxs)(s.td,{children:["Sleeps until the ",(0,r.jsx)(s.code,{children:"long"})," timestamp (epoch millis) specified here."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"iso_date"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"sleep_length"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Sleeps until the ISO-formatted date specified here."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startmultiplethreadsnode",children:["Message ",(0,r.jsx)(s.code,{children:"StartMultipleThreadsNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Iterates over a JSON_ARR and starts a Child ThreadRun for each element in the\nlist."}),"\n",(0,r.jsx)(s.p,{children:"Returns a JSON_ARR containing the thread_run_number of each spawned child."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to spawn."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startmultiplethreadsnodevariablesentry",children:"StartMultipleThreadsNode.VariablesEntry"})}),(0,r.jsx)(s.td,{children:"Variables which are passed into the child ThreadRuns. These assignments are the same for all spawned threads."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"iterable"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsxs)(s.td,{children:["Assignment that resolves to a JSON_ARR. For each element in the list, a child ThreadRun is started. The reserved ",(0,r.jsx)(s.code,{children:"INPUT"})," variable for each Child is set to the corresponding item in the list."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startmultiplethreadsnodevariablesentry",children:["Message ",(0,r.jsx)(s.code,{children:"StartMultipleThreadsNode.VariablesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startthreadnode",children:["Message ",(0,r.jsx)(s.code,{children:"StartThreadNode"})]}),"\n",(0,r.jsx)(s.p,{children:"Starts a Child ThreadRun with a specific ThreadSpec."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec to spawn."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variables"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#startthreadnodevariablesentry",children:"StartThreadNode.VariablesEntry"})}),(0,r.jsx)(s.td,{children:"The input variables to pass into the Child ThreadRun."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"startthreadnodevariablesentry",children:["Message ",(0,r.jsx)(s.code,{children:"StartThreadNode.VariablesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadretentionpolicy",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadRetentionPolicy"})]}),"\n",(0,r.jsx)(s.p,{children:"ThreadRetentionPolicy specifies how long to keep record of a ThreadRun and its associated\nNodeRun's and TaskRun's and Variables after the ThreadRun has been completed."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"seconds_after_thread_termination"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"thread_gc_policy"})]}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Delete associated ThreadRun's X seconds after they terminate, regardless of status."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadspec",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadSpec"})]}),"\n",(0,r.jsx)(s.p,{children:"Defines a blueprint for a ThreadRun, which is a thread of execution inside a\nWfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"nodes"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadspecnodesentry",children:"ThreadSpec.NodesEntry"})}),(0,r.jsx)(s.td,{children:"The Nodes inside this ThreadSpec. Maps from name to Node."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"variable_defs"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadvardef",children:"ThreadVarDef"})}),(0,r.jsx)(s.td,{children:"Defines Variables that are local to ThreadRun's of this ThreadSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"interrupt_defs"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#interruptdef",children:"InterruptDef"})}),(0,r.jsx)(s.td,{children:"Defines all interrupts for this ThreadSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retention_policy"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadretentionpolicy",children:"ThreadRetentionPolicy"})}),(0,r.jsx)(s.td,{children:"Optional retention policy to clean up ThreadRun's of this ThreadSpec after they have been completed. This is important for long-lived WfRun's that could have hundreds of ThreadRun's, because a ThreadRun has a record inside the WfRun itself."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadspecnodesentry",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadSpec.NodesEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#node",children:"Node"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadspecmigration",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadSpecMigration"})]}),"\n",(0,r.jsx)(s.p,{children:"EXPERIMENTAL: Specification for how to migrate a ThreadRun of a specific ThreadSpec\nfrom one WfSpec to another WfSpec version."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_thread_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"The name of the ThreadSpec in the new WfSpec that this ThreadSpec should migrate to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"node_migrations"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadspecmigrationnodemigrationsentry",children:"ThreadSpecMigration.NodeMigrationsEntry"})}),(0,r.jsx)(s.td,{children:"Map from name of the nodes on the current ThreadSpec to the migration to perform on it to move it to a new WfSpec."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadspecmigrationnodemigrationsentry",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadSpecMigration.NodeMigrationsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#nodemigration",children:"NodeMigration"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"threadvardef",children:["Message ",(0,r.jsx)(s.code,{children:"ThreadVarDef"})]}),"\n",(0,r.jsx)(s.p,{children:"Denotes a variable declaration at the ThreadSpec level."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"var_def"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabledef",children:"VariableDef"})}),(0,r.jsx)(s.td,{children:"Is the actual VariableDefinition containing name and type."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"required"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether the variable is required as input to the threadRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"searchable"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"bool"}),(0,r.jsx)(s.td,{children:"Whether this variable has an index configured."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"json_indexes"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#jsonindex",children:"JsonIndex"})}),(0,r.jsx)(s.td,{children:"Valid for JSON_OBJ and JSON_ARR variables only. List of JSON fields to index."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"access_level"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfrunvariableaccesslevel",children:"WfRunVariableAccessLevel"})}),(0,r.jsx)(s.td,{children:"The Access Level of this variable."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"throweventnode",children:["Message ",(0,r.jsx)(s.code,{children:"ThrowEventNode"})]}),"\n",(0,r.jsx)(s.p,{children:"A SubNode that throws a WorkflowEvent of a specific type. There is no output."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"event_def_id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{children:"The WorkflowEventDefId of the WorkflowEvent that is thrown"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"A VariableAssignment defining the content of the WorkflowEvent that is thrown"})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"usertasknode",children:["Message ",(0,r.jsx)(s.code,{children:"UserTaskNode"})]}),"\n",(0,r.jsx)(s.p,{children:"The UserTaskNode creates a UserTaskRun, which is used to get input from a human\nuser into the workflow."}),"\n",(0,r.jsx)(s.p,{children:"The output is a JSON_OBJ variable with one key/value pair for each UserTaskField."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_def_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["Denotes the name of the ",(0,r.jsx)(s.code,{children:"UserTaskDef"})," that should create the ",(0,r.jsx)(s.code,{children:"UserTaskRun"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_group"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Denotes the user_group to which the UserTaskRun is assigned upon creation."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_id"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Denotes the user_id to which the UserTaskRun is assigned upon creation."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"actions"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#utactiontrigger",children:"UTActionTrigger"})}),(0,r.jsx)(s.td,{children:'Specifies a list of actions that happen on various time-based triggers. Actions include reassigning the UserTaskRun, cancelling the UserTaskRun, or executing a "reminder" TaskRun.'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"user_task_def_version"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"If set, then the UserTaskRun will always have this specific version of the UserTaskDef. Otherwise, the UserTaskRun will have the latest version."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"notes"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsxs)(s.td,{children:["Specifies the value to be displayed on the ",(0,r.jsx)(s.code,{children:"notes"})," field of the UserTaskRun."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"on_cancellation_exception_name"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Specifies the name of the exception thrown when the User Task is canceled. If not set, then the cancellation or timeout of a User Task Run throws an ERROR rather than an EXCEPTION."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforconditionnode",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForConditionNode"})]}),"\n",(0,r.jsx)(s.p,{children:"A SubNode that blocks until a condition is satisfied in the WfRun.\nThere is no output."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"condition"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#edgecondition",children:"EdgeCondition"})}),(0,r.jsx)(s.td,{children:"The condition that this node will block for."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforthreadsnode",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForThreadsNode"})]}),"\n",(0,r.jsxs)(s.p,{children:["Specifies that a ThreadRun will wait for certain specified Child ThreadRun's to\ncomplete or fail before the WfRun continues. If one of the Child ThreadRun's\nthrows a Failure that is not caught by the ",(0,r.jsx)(s.code,{children:"per_thread_failure_handlers"}),",\nthen the Child ThreadRun's Failure is thrown by the WaitForThreadsRun."]}),"\n",(0,r.jsx)(s.p,{children:"No output."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"threads"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"threads_to_wait_for"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsnodethreadstowaitfor",children:"WaitForThreadsNode.ThreadsToWaitFor"})}),(0,r.jsx)(s.td,{children:"Specifies that the WaitForThreadsRun will wait for the threads specified here."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_list"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"threads_to_wait_for"})]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsxs)(s.td,{children:["Specifies that the WaitForThreadsRun will wait for a list of ThreadRun's contained in the JSON_ARR value specified here. Each element in the list must be an INT representing the ",(0,r.jsx)(s.code,{children:"number"})," of a ThreadRun that we're waiting for."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"per_thread_failure_handlers"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#failurehandlerdef",children:"FailureHandlerDef"})}),(0,r.jsxs)(s.td,{children:["If any of the child ThreadRun's that we are waiting for throw a Failure, we will evaluate it against these FailureHandlerDef's and run the first matching FailureHandler (if any). The FailureHandler will be a child of the child, which means that it has access to all of the variables in the scope of the failed Child ThreadRun.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"This is different from Node-level Failure Handlers, which would be ",(0,r.jsx)(s.em,{children:"siblings"})," of the ThreadRuns that we're waiting for, and would run only when the overall nodeRun has failed."]})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforthreadsnodethreadtowaitfor",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForThreadsNode.ThreadToWaitFor"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_run_number"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variableassignment",children:"VariableAssignment"})}),(0,r.jsx)(s.td,{children:"Causes the WaitForThreadsNodeRun to wait for the ThreadRun whose number matches the value specified here. Must resolve to an INT."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"waitforthreadsnodethreadstowaitfor",children:["Message ",(0,r.jsx)(s.code,{children:"WaitForThreadsNode.ThreadsToWaitFor"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"threads"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#waitforthreadsnodethreadtowaitfor",children:"WaitForThreadsNode.ThreadToWaitFor"})}),(0,r.jsx)(s.td,{children:"Wait for one or more ThreadRun's"})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspec",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpec"})]}),"\n",(0,r.jsxs)(s.p,{children:["A ",(0,r.jsx)(s.code,{children:"WfSpec"})," defines the logic for a workflow in LittleHorse. It is a metadata object\nand is a blueprint for a ",(0,r.jsx)(s.code,{children:"WfRun"})," execution."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecid",children:"WfSpecId"})}),(0,r.jsxs)(s.td,{children:["The ID of the ",(0,r.jsx)(s.code,{children:"WfSpec"}),". Note that this ID is versioned with both a major version and a minor revision. Creating new WfSpec's with the same name and different specifications results in a completely new ",(0,r.jsx)(s.code,{children:"WfSpec"})," object whose ",(0,r.jsx)(s.code,{children:"id.name"})," is the same but with different version."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsxs)(s.td,{children:["The timestamp at which the ",(0,r.jsx)(s.code,{children:"WfSpec"})," was created."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"frozen_variables"})}),(0,r.jsx)(s.td,{children:"repeated"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadvardef",children:"ThreadVarDef"})}),(0,r.jsx)(s.td,{children:"Variables whose types cannot be changed without causing a Breaking Change between the versions."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"status"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#metadatastatus",children:"MetadataStatus"})}),(0,r.jsxs)(s.td,{children:["The Status of the ",(0,r.jsx)(s.code,{children:"WfSpec"}),". Currently, only ",(0,r.jsx)(s.code,{children:"ACTIVE"})," exists. This field will be used in the future when de-commissioning a WfSpec gracefully."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_specs"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecthreadspecsentry",children:"WfSpec.ThreadSpecsEntry"})}),(0,r.jsxs)(s.td,{children:["The various ThreadSpec's in this ",(0,r.jsx)(s.code,{children:"WfSpec"}),". Each ",(0,r.jsx)(s.code,{children:"ThreadSpec"})," defines a blueprint for a parallel thread of execution (a ",(0,r.jsx)(s.code,{children:"ThreadRun"}),"). They are referred to by their names."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"entrypoint_thread_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsxs)(s.td,{children:["The name of the ",(0,r.jsx)(s.code,{children:"ENTRYPOINT"})," ThreadSpec. The Entrypoint is the ",(0,r.jsx)(s.code,{children:"ThreadSpec"})," for the Entrypoint ThreadRun, which is the ",(0,r.jsx)(s.code,{children:"ThreadRun"})," that is created upon starting the ",(0,r.jsx)(s.code,{children:"WfRun"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"retention_policy"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workflowretentionpolicy",children:"WorkflowRetentionPolicy"})}),(0,r.jsxs)(s.td,{children:["Optional policy that configures cleaning up old ",(0,r.jsx)(s.code,{children:"WfRun"}),"'s after they are completed or failed. Recommended for production settings to avoid running out of disk space; unless you are using a ",(0,r.jsx)(s.code,{children:"WfRun"})," as a data record, in which case the application should clean up ",(0,r.jsx)(s.code,{children:"WfRun"}),"'s as appropriate."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"migration"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecversionmigration",children:"WfSpecVersionMigration"})}),(0,r.jsxs)(s.td,{children:["EXPERIMENTAL: ongoing migration from one version of a ",(0,r.jsx)(s.code,{children:"WfSpec"})," to another."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"parent_wf_spec"})}),(0,r.jsx)(s.td,{children:"optional"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecparentwfspecreference",children:"WfSpec.ParentWfSpecReference"})}),(0,r.jsx)(s.td,{children:"Reference to the parent WfSpec. If this is set, all WfRun's for this WfSpec must be the child of a WfRun belonging to the referenced WfSpec."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecparentwfspecreference",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpec.ParentWfSpecReference"})]}),"\n",(0,r.jsxs)(s.p,{children:["Reference to another WfSpec. If a WfSpec has a ParentWfSpecReference, then all\nWfRun's for that WfSpec ",(0,r.jsx)(s.em,{children:"MUST"})," be the child of a WfRun of the provided WfSpec; meaning\nthat the RunWf RPC must provide a ",(0,r.jsx)(s.code,{children:"parent_wf_run_id"})," that belongs to the specified\nWfSpec."]}),"\n",(0,r.jsx)(s.p,{children:"Currently, only reference by names is supported."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_name"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{children:"Name of the Parent WfSpec"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"wf_spec_major_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"FOR NOW: no validation of variables on parent. In the future we will pass wf_spec_major_version, but we should probably examine the rules for evolution in the future."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecthreadspecsentry",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpec.ThreadSpecsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadspec",children:"ThreadSpec"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecversionmigration",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecVersionMigration"})]}),"\n",(0,r.jsx)(s.p,{children:"EXPERIMENTAL: Specification for how to migrate an in-flight WfRun from one WfSpec\nto another WfSpec version."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_major_version"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The major version of the WfSpec that we are migrating to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"new_revision"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"int32"}),(0,r.jsx)(s.td,{children:"The revision of the WfSpec that we are migrating to."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"thread_spec_migrations"})}),(0,r.jsx)(s.td,{children:"map"}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#wfspecversionmigrationthreadspecmigrationsentry",children:"WfSpecVersionMigration.ThreadSpecMigrationsEntry"})}),(0,r.jsx)(s.td,{children:"Map from ThreadSpec name to a specifier determining how to migrate ThreadRun's to the new version of the WfSpec."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"wfspecversionmigrationthreadspecmigrationsentry",children:["Message ",(0,r.jsx)(s.code,{children:"WfSpecVersionMigration.ThreadSpecMigrationsEntry"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"key"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"string"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"value"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#threadspecmigration",children:"ThreadSpecMigration"})}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"workflowretentionpolicy",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowRetentionPolicy"})]}),"\n",(0,r.jsx)(s.p,{children:"A WorkflowRetentionPolicy configures how long a WfRun is retained in the data store before\nbeing deleted after it is completed or failed."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"seconds_after_wf_termination"})}),(0,r.jsxs)(s.td,{children:["oneof ",(0,r.jsx)(s.code,{children:"wf_gc_policy"})]}),(0,r.jsx)(s.td,{children:"int64"}),(0,r.jsx)(s.td,{children:"Delete all WfRun's X seconds after they terminate, regardless of status."})]})})]}),"\n",(0,r.jsxs)(s.h3,{id:"workflowevent",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEvent"})]}),"\n",(0,r.jsxs)(s.p,{children:['A WorkflowEvent represents a "Thing That Happened" ',(0,r.jsx)(s.em,{children:"INSIDE"})," a WfRun. It is DIFFERENT from\nan ExternalEvent, because an ExternalEvent represents something that happened OUTSIDE the WfRun,\nand is used to send information to the WfRun."]}),"\n",(0,r.jsx)(s.p,{children:"In contrast, a WorkflowEvent is thrown by the WfRun and is used to send information to the outside\nworld."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventid",children:"WorkflowEventId"})}),(0,r.jsx)(s.td,{children:"The ID of the WorkflowEvent. Contains WfRunId and WorkflowEventDefId."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"content"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variablevalue",children:"VariableValue"})}),(0,r.jsx)(s.td,{children:"The content of the WorkflowEvent."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time that the WorkflowEvent was created."})]})]})]}),"\n",(0,r.jsxs)(s.h3,{id:"workfloweventdef",children:["Message ",(0,r.jsx)(s.code,{children:"WorkflowEventDef"})]}),"\n",(0,r.jsx)(s.p,{children:"The WorkflowEventDef defines the blueprint for a WorkflowEvent."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Field"}),(0,r.jsx)(s.th,{children:"Label"}),(0,r.jsx)(s.th,{children:"Type"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"id"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#workfloweventdefid",children:"WorkflowEventDefId"})}),(0,r.jsx)(s.td,{children:"The ID of the WorkflowEventDef. Contains the name of the WorkflowEventDef."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"created_at"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:"google.protobuf.Timestamp"}),(0,r.jsx)(s.td,{children:"The time that the WorkflowEventDef was created at."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"type"})}),(0,r.jsx)(s.td,{}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.a,{href:"#variabletype",children:"VariableType"})}),(0,r.jsx)(s.td,{children:"The type of 'content' thrown with a WorkflowEvent based on this WorkflowEventDef."})]})]})]}),"\n",(0,r.jsx)(s.h2,{id:"littlehorse-enums",children:"LittleHorse Enums"}),"\n",(0,r.jsx)(s.p,{children:"This section contains the enums defined by the LittleHorse API."}),"\n",(0,r.jsx)(s.h3,{id:"aclaction",children:"Enum ACLAction"}),"\n",(0,r.jsx)(s.p,{children:"Describes an Action that can be taken over a specific set of resources."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"READ"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["Allows all RPC's that start with ",(0,r.jsx)(s.code,{children:"Get"}),", ",(0,r.jsx)(s.code,{children:"List"}),", and ",(0,r.jsx)(s.code,{children:"Search"})," in relation to the metadata (eg. ",(0,r.jsx)(s.code,{children:"TaskDef"})," for ",(0,r.jsx)(s.code,{children:"ACL_TASK"}),") or run data (eg. ",(0,r.jsx)(s.code,{children:"TaskRun"})," for ",(0,r.jsx)(s.code,{children:"ACL_TASK"}),")"]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"RUN"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["Allows RPC's that are needed for mutating the ",(0,r.jsx)(s.em,{children:"runs"})," of the resource. For example, ",(0,r.jsx)(s.code,{children:"RUN"})," over ",(0,r.jsx)(s.code,{children:"ACL_TASK"})," allows the ",(0,r.jsx)(s.code,{children:"ReportTask"})," and ",(0,r.jsx)(s.code,{children:"PollTask"})," RPC's, and ",(0,r.jsx)(s.code,{children:"RUN"})," over ",(0,r.jsx)(s.code,{children:"ACL_WORKFLOW"})," allows the ",(0,r.jsx)(s.code,{children:"RunWf"}),", ",(0,r.jsx)(s.code,{children:"DeleteWfRun"}),", ",(0,r.jsx)(s.code,{children:"StopWfRun"}),", and ",(0,r.jsx)(s.code,{children:"ResumeWfRun"})," RPC's."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"WRITE_METADATA"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsxs)(s.td,{children:["Allows mutating metadata. For example, ",(0,r.jsx)(s.code,{children:"WRITE_METADATA"})," over ",(0,r.jsx)(s.code,{children:"ACL_WORKFLOW"})," allows mutating ",(0,r.jsx)(s.code,{children:"WfSpec"}),"s, and ",(0,r.jsx)(s.code,{children:"WRITE_METADATA"})," over ",(0,r.jsx)(s.code,{children:"ACL_TASK"})," allows mutating ",(0,r.jsx)(s.code,{children:"TaskDef"}),"s."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ALL_ACTIONS"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"Allows all actions related to a resource."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"aclresource",children:"Enum ACLResource"}),"\n",(0,r.jsx)(s.p,{children:"Defines a resource type for ACL's."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_WORKFLOW"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["Refers to ",(0,r.jsx)(s.code,{children:"WfSpec"})," and ",(0,r.jsx)(s.code,{children:"WfRun"})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_TASK"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["Refers to ",(0,r.jsx)(s.code,{children:"TaskDef"})," and ",(0,r.jsx)(s.code,{children:"TaskRun"})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_EXTERNAL_EVENT"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsxs)(s.td,{children:["Refers to ",(0,r.jsx)(s.code,{children:"ExternalEventDef"})," and ",(0,r.jsx)(s.code,{children:"ExternalEvent"})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_USER_TASK"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsxs)(s.td,{children:["Refers to ",(0,r.jsx)(s.code,{children:"UserTaskDef"})," and ",(0,r.jsx)(s.code,{children:"UserTaskRun"})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_PRINCIPAL"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsxs)(s.td,{children:["Refers to the ",(0,r.jsx)(s.code,{children:"Principal"})," resource. Currently, the ",(0,r.jsx)(s.code,{children:"ACL_PRINCIPAL"})," permission is only valid in the ",(0,r.jsx)(s.code,{children:"global_acls"})," field of the ",(0,r.jsx)(s.code,{children:"Principal"}),". A ",(0,r.jsx)(s.code,{children:"Principal"})," who only has access to a specific Tenant cannot create othe Principals because a Principal is scoped to the Cluster, and not to a Tenant."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_TENANT"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsxs)(s.td,{children:["Refers to the ",(0,r.jsx)(s.code,{children:"Tenant"})," resource. The ",(0,r.jsx)(s.code,{children:"ACL_TENANT"})," permission is only valid in the ",(0,r.jsx)(s.code,{children:"global_acls"})," field of the ",(0,r.jsx)(s.code,{children:"Principal"}),". This is because the ",(0,r.jsx)(s.code,{children:"Tenant"})," resource is cluster-scoped."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_ALL_RESOURCES"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsxs)(s.td,{children:["Refers to all resources. In the ",(0,r.jsx)(s.code,{children:"global_acls"})," field, this includes ",(0,r.jsx)(s.code,{children:"Principal"})," and ",(0,r.jsx)(s.code,{children:"Tenant"})," resources. In the ",(0,r.jsx)(s.code,{children:"per_tenant_acls"})," field, this does not include ",(0,r.jsx)(s.code,{children:"Principal"})," and ",(0,r.jsx)(s.code,{children:"Tenant"})," since those are cluster-scoped resources."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_TASK_WORKER_GROUP"}),(0,r.jsx)(s.td,{children:"7"}),(0,r.jsxs)(s.td,{children:["Refers to the ",(0,r.jsx)(s.code,{children:"TaskWorkerGroup"})," associated with a TaskDef"]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACL_WORKFLOW_EVENT"}),(0,r.jsx)(s.td,{children:"8"}),(0,r.jsxs)(s.td,{children:["Refers to ",(0,r.jsx)(s.code,{children:"WorkflowEventDef"})," and ",(0,r.jsx)(s.code,{children:"WorkflowEvent"})]})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"lherrortype",children:"Enum LHErrorType"}),"\n",(0,r.jsx)(s.p,{children:"This enum is all of the types of technical failure that can occur in a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"CHILD_FAILURE"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"A child ThreadRun failed with a technical ERROR."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"VAR_SUB_ERROR"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"Failed substituting input variables into a NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"VAR_MUTATION_ERROR"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"Failed mutating variables after a NodeRun successfully completed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"USER_TASK_CANCELLED"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"A UserTaskRun was cancelled (EVOLVING: this will become a Business EXCEPTION)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TIMEOUT"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"A NodeRun failed due to a timeout."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_FAILURE"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsx)(s.td,{children:"A TaskRun failed due to an unexpected error."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"VAR_ERROR"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsx)(s.td,{children:"Wrapper for VAR_SUB_ERROR and VAR_MUTATION_ERROR"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_ERROR"}),(0,r.jsx)(s.td,{children:"7"}),(0,r.jsx)(s.td,{children:"Wrapper for TASK_FALIURE and TIMEOUT"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"INTERNAL_ERROR"}),(0,r.jsx)(s.td,{children:"8"}),(0,r.jsx)(s.td,{children:"An unexpected LittleHorse Internal error occurred. This is not expected to happen."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"lhstatus",children:"Enum LHStatus"}),"\n",(0,r.jsx)(s.p,{children:"Status used for WfRun, ThreadRun, and NodeRun"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"STARTING"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"The entity is starting."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"RUNNING"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"The entity is running."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"COMPLETED"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"The entity is completed. This is a terminal state."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HALTING"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsxs)(s.td,{children:["The entity will move to ",(0,r.jsx)(s.code,{children:"HALTED"})," as soon as all preconditions for halting are satisfied."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HALTED"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"The entity is halted, either by user intervention or by the workflow scheduler."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ERROR"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsx)(s.td,{children:"The entity has failed due to a technical failure, such as a type conversion error, a task timeout due to network failure, or a task worker crash."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"EXCEPTION"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsx)(s.td,{children:"The entity has failed due to a business exception defined by the user."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"metadatastatus",children:"Enum MetadataStatus"}),"\n",(0,r.jsx)(s.p,{children:"Status of a Metadata Object, such as WfSpec or TaskDef"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ACTIVE"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"ACTIVE means the object can be used."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ARCHIVED"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"An ARCHIVED WfSpec can no longer be used to create new WfRun's, but existing WfRun's will be allowed to run to completion."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TERMINATING"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"A TERMINATING WfSpec is actively deleting all running WfRun's, and will self-destruct once all of its child WfRun's are terminated."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"metricswindowlength",children:"Enum MetricsWindowLength"}),"\n",(0,r.jsx)(s.p,{children:"Metrics"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"MINUTES_5"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HOURS_2"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"DAYS_1"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"taskstatus",children:"Enum TaskStatus"}),"\n",(0,r.jsx)(s.p,{children:"Status of a TaskRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_SCHEDULED"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"Scheduled in the Task Queue but not yet picked up by a Task Worker."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_RUNNING"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"Picked up by a Task Worker, but not yet reported or timed out."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_SUCCESS"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"Successfully completed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_FAILED"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"Task Worker reported a technical failure while attempting to execute the TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_TIMEOUT"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"Task Worker did not report a result in time."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_OUTPUT_SERIALIZING_ERROR"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsx)(s.td,{children:"Task Worker reported that it was unable to serialize the output of the TaskRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_INPUT_VAR_SUB_ERROR"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsx)(s.td,{children:"Task Worker was unable to deserialize the input variables into appropriate language-specific objects to pass into the Task Function"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_EXCEPTION"}),(0,r.jsx)(s.td,{children:"8"}),(0,r.jsx)(s.td,{children:"Task Function business logic determined that there was a business exception."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK_PENDING"}),(0,r.jsx)(s.td,{children:"9"}),(0,r.jsx)(s.td,{children:'Refers to a TaskAttempt that is not yet scheduled. This happens when using retries with an ExponentialBackoffRetryPolicy: the TaskAttempt isn\'t supposed to be scheduled until it "matures", but it does already exist.'})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"variabletype",children:"Enum VariableType"}),"\n",(0,r.jsx)(s.p,{children:"Type of a Varaible in LittleHorse. Corresponds to the possible value type's of a\nVariableValue."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"JSON_OBJ"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["An object represented as a json string. ",(0,r.jsx)("br",{})]})]})})]}),"\n",(0,r.jsxs)(s.p,{children:["The ",(0,r.jsx)(s.code,{children:"JSON_OBJ"})," variable allows you to store complex objects in the JSON format. When using the Java and GoLang SDK's, the ",(0,r.jsx)(s.code,{children:"JSON_OBJ"})," variable type is often used transparently to the user. For example, the Java Task Worker SDK can inspect your method signature and automatically deserialize an input variable into a POJO. |\n| JSON_ARR | 1 | The ",(0,r.jsx)(s.code,{children:"JSON_ARR"})," variable allows you to store collections of objects as a JSON array. The behavior is similar to the ",(0,r.jsx)(s.code,{children:"JSON_OBJ"})," variable type. |\n| DOUBLE | 2 | The ",(0,r.jsx)(s.code,{children:"DOUBLE"})," variable type is a 64-bit floating point number. It can be cast to an ",(0,r.jsx)(s.code,{children:"INT"}),". |\n| BOOL | 3 | Boolean denotes a simple boolean switch. |\n| STR | 4 | The ",(0,r.jsx)(s.code,{children:"STR"})," variable type is stored as a String. ",(0,r.jsx)(s.code,{children:"INT"}),", ",(0,r.jsx)(s.code,{children:"DOUBLE"}),", and ",(0,r.jsx)(s.code,{children:"BOOL"})," variables can be cast to a ",(0,r.jsx)(s.code,{children:"STR"}),". |\n| INT | 5 | The ",(0,r.jsx)(s.code,{children:"INT"})," variable type is stored as a 64-bit integer. The ",(0,r.jsx)(s.code,{children:"INT"})," can be cast to a ",(0,r.jsx)(s.code,{children:"DOUBLE"}),". |\n| BYTES | 6 | The ",(0,r.jsx)(s.code,{children:"BYTES"})," variable type allows you to store an arbitrary byte string. |"]}),"\n",(0,r.jsx)(s.h3,{id:"comparator",children:"Enum Comparator"}),"\n",(0,r.jsx)(s.p,{children:"Operator for comparing two values to create a boolean expression."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"LESS_THAN"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["Equivalent to ",(0,r.jsx)(s.code,{children:"<"}),". Only valid for primitive types (no JSON_OBJ or JSON_ARR)."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"GREATER_THAN"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["Equivalent to ",(0,r.jsx)(s.code,{children:">"}),". Only valid for primitive types (no JSON_OBJ or JSON_ARR)."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"LESS_THAN_EQ"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsxs)(s.td,{children:["Equivalent to ",(0,r.jsx)(s.code,{children:"<="}),". Only valid for primitive types (no JSON_OBJ or JSON_ARR)."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"GREATER_THAN_EQ"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsxs)(s.td,{children:["Equivalent to ",(0,r.jsx)(s.code,{children:">="}),". Only valid for primitive types (no JSON_OBJ or JSON_ARR)."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"EQUALS"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"This is valid for any variable type, and is similar to .equals() in Java."})]})]})]}),"\n",(0,r.jsxs)(s.p,{children:["One note: if the RHS is a different type from the LHS, then LittleHorse will try to cast the RHS to the same type as the LHS. If the cast fails, then the ThreadRun fails with a VAR_SUB_ERROR. |\n| NOT_EQUALS | 5 | This is the inverse of ",(0,r.jsx)(s.code,{children:"EQUALS"})," |\n| IN | 6 | Only valid if the RHS is a JSON_OBJ or JSON_ARR. Valid for any type on the LHS."]}),"\n",(0,r.jsxs)(s.p,{children:["For the JSON_OBJ type, this returns true if the LHS is equal to a ",(0,r.jsx)(s.em,{children:"KEY"})," in the RHS. For the JSON_ARR type, it returns true if one of the elements of the RHS is equal to the LHS. |\n| NOT_IN | 7 | The inverse of IN. |"]}),"\n",(0,r.jsx)(s.h3,{id:"utactiontriggeruthook",children:"Enum UTActionTrigger.UTHook"}),"\n",(0,r.jsx)(s.p,{children:"Enumerates the different lifecycle hooks that can cause the timer to start running."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ON_ARRIVAL"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["The hook should be scheduled ",(0,r.jsx)(s.code,{children:"delay_seconds"})," after the UserTaskRun is created. This hook only causes the action to be scheduled once."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ON_TASK_ASSIGNED"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["The hook should be scheduled ",(0,r.jsx)(s.code,{children:"delay_seconds"}),' after the ownership of the UserTaskRun changes. This hook causes the Action to be scheduled one or more times. The first time is scheduled when the UserTaskRun is created, since we treat the change from "UserTaskRun is nonexistent" to "UserTaskRun is owned by a userId or userGroup" as a change in ownership.']})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"variablemutationtype",children:"Enum VariableMutationType"}),"\n",(0,r.jsx)(s.p,{children:"Enumerates the available operations to mutate a variable in a WfRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ASSIGN"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"Set the variable specified by the LHS to the value of the RHS."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ADD"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"Add the RHS to the LHS."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"EXTEND"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"Append the RHS to the LHS (valid if the LHS is a STR or JSON_ARR)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"SUBTRACT"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"Subtract the RHS from the LHS (both must be INT or DOUBLE)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"MULTIPLY"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"Multiply the LHS by the RHS (both must be INT or DOUBLE)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"DIVIDE"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsx)(s.td,{children:"Divide the LHS by the RHS (both must be INT or DOUBLE)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"REMOVE_IF_PRESENT"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsx)(s.td,{children:"Remove any occurrences of RHS from LHS (LHS must be JSON_ARR)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"REMOVE_INDEX"}),(0,r.jsx)(s.td,{children:"7"}),(0,r.jsx)(s.td,{children:"Remove item at index RHS from LHS (LHS must be JSON_ARR)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"REMOVE_KEY"}),(0,r.jsx)(s.td,{children:"8"}),(0,r.jsx)(s.td,{children:"Remove the key specified by RHS from the LHS (LHS must be JSON_OBJ)"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"waitforthreadsrunwaitingthreadstatus",children:"Enum WaitForThreadsRun.WaitingThreadStatus"}),"\n",(0,r.jsx)(s.p,{children:"The status of a single ThreadRun that we are waiting for."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"THREAD_IN_PROGRESS"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"The ThreadRun is in progress (i.e. not COMPLETED nor EXCEPTION nor ERROR)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"THREAD_HANDLING_FAILURE"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"The ThreadRun failed with some failure, and the FailureHandler is running for that Failure."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"THREAD_COMPLETED_OR_FAILURE_HANDLED"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:'We can mark this ThreadRun as "already waited for", meaning that either: 1. It completed successfully, OR 2. It failed, and the Failure Handler successfully completed'})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"THREAD_UNSUCCESSFUL"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"The ThreadRun did not complete successfully, and there wasn't a successful run of a Failure Handler for the Failure that was thrown."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"allowedupdatetype",children:"Enum AllowedUpdateType"}),"\n",(0,r.jsx)(s.p,{children:"This enum controls the behavior of a PutWfSpecRequest when a WfSpec with the same\nname previously exists."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ALL_UPDATES"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"Allows any update: both minor (revsion) changes and breaking (majorVersion) changes are accepted"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"MINOR_REVISION_UPDATES"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"Allows only backwards-compatible changes that do not change the required input variables or the searchable variables in the WfSpec."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"NO_UPDATES"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"Rejects any changes to the WfSpec."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"searchnoderunrequestnodetype",children:"Enum SearchNodeRunRequest.NodeType"}),"\n",(0,r.jsx)(s.p,{children:"This enum denotes the type of a NodeRun."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"TASK"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"TASK node schedules a TaskRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"EXTERNAL_EVENT"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"EXTERNAL_EVENT blocks the ThreadRun until a specified ExternalEvent arrives"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ENTRYPOINT"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"ENTRYPOINT kicks off a ThreadRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"EXIT"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"EXIT completes a ThreadRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"START_THREAD"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"START_THREAD creates a Child ThreadRun"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"WAIT_THREADS"}),(0,r.jsx)(s.td,{children:"5"}),(0,r.jsx)(s.td,{children:"WAIT_THREADS waits for one or more child ThreadRuns to complete"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"SLEEP"}),(0,r.jsx)(s.td,{children:"6"}),(0,r.jsx)(s.td,{children:"SLEEP makes the ThreadRun sleep for a specified time"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"USER_TASK"}),(0,r.jsx)(s.td,{children:"7"}),(0,r.jsx)(s.td,{children:"USER_TASK creates a UserTaskRun and blocks until the UserTaskRun is completed."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"START_MULTIPLE_THREADS"}),(0,r.jsx)(s.td,{children:"8"}),(0,r.jsx)(s.td,{children:"START_MULTIPLE_THREADS iterates over a list and starts a Child Thread for each item"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"saveusertaskrunprogressrequestsaveusertaskrunassignmentpolicy",children:"Enum SaveUserTaskRunProgressRequest.SaveUserTaskRunAssignmentPolicy"}),"\n",(0,r.jsxs)(s.p,{children:["Configures how to handle ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," ownership when saving it."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"FAIL_IF_CLAIMED_BY_OTHER"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"If the UserTaskRun is already assigned to a user_id, then the request throws a FAILED_PRECONDITION error."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"IGNORE_CLAIM"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["If the UserTaskRun is already assigned to a user_id, then the request will leave the ",(0,r.jsx)(s.code,{children:"UserTaskRun"})," assigned to the current user but still update the ",(0,r.jsx)(s.code,{children:"results"})," and log in the ",(0,r.jsx)(s.code,{children:"events"})," who updated the results."]})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"usertaskrunstatus",children:"Enum UserTaskRunStatus"}),"\n",(0,r.jsx)(s.p,{children:"The status that a UserTaskRun can be in."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"UNASSIGNED"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"Not assigned to a specific user yet."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ASSIGNED"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"Assigned to a specific user, but not completed or cancelled yet."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"DONE"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"Done."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"CANCELLED"}),(0,r.jsx)(s.td,{children:"4"}),(0,r.jsx)(s.td,{children:"Cancelled."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"threadtype",children:"Enum ThreadType"}),"\n",(0,r.jsx)(s.p,{children:"The type of a ThreadRUn."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"ENTRYPOINT"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsx)(s.td,{children:"The ENTRYPOINT ThreadRun. Exactly one per WfRun. Always has number == 0."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"CHILD"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsx)(s.td,{children:"A ThreadRun explicitly created by another ThreadRun via a START_THREAD or START_MULTIPLE_THREADS NodeRun."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"INTERRUPT"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsx)(s.td,{children:"A ThreadRun that was created to handle an Interrupt."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"FAILURE_HANDLER"}),(0,r.jsx)(s.td,{children:"3"}),(0,r.jsx)(s.td,{children:"A ThreadRun that was created to handle a Failure."})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"failurehandlerdeflhfailuretype",children:"Enum FailureHandlerDef.LHFailureType"}),"\n",(0,r.jsx)(s.p,{children:"Specifies a type of Failure"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"FAILURE_TYPE_ERROR"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["FAILURE_TYPE_ERROR specifies any technical ",(0,r.jsx)(s.code,{children:"ERROR"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"FAILURE_TYPE_EXCEPTION"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["Specifies a user-defined, business-related ",(0,r.jsx)(s.code,{children:"EXCEPTION"}),"."]})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"wfrunvariableaccesslevel",children:"Enum WfRunVariableAccessLevel"}),"\n",(0,r.jsx)(s.p,{children:"Determines the Access Level for a Variable in a ThreadSpec/WfSpec."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Number"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"PUBLIC_VAR"}),(0,r.jsx)(s.td,{children:"0"}),(0,r.jsxs)(s.td,{children:["A ",(0,r.jsx)(s.code,{children:"PUBLIC_VAR"})," can be accessed (read + mutated) by child ",(0,r.jsx)(s.code,{children:"WfRun"}),"'s."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"PRIVATE_VAR"}),(0,r.jsx)(s.td,{children:"1"}),(0,r.jsxs)(s.td,{children:["A ",(0,r.jsx)(s.code,{children:"PRIVATE_VAR"})," cannot be accessed by a child ",(0,r.jsx)(s.code,{children:"WfRun"}),"."]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"INHERITED_VAR"}),(0,r.jsx)(s.td,{children:"2"}),(0,r.jsxs)(s.td,{children:["An ",(0,r.jsx)(s.code,{children:"INHERITED_VAR"})," is inherited from the parent ",(0,r.jsx)(s.code,{children:"WfRun"}),". Only valid in a ",(0,r.jsx)(s.code,{children:"WfSpec"})," that has a parent. Also can only be declared in the Entrypoint Thread."]})]})]})]})]})}function x(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,s,d)=>{d.d(s,{R:()=>i,x:()=>h});var r=d(6540);const n={},t=r.createContext(n);function i(e){const s=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function h(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),r.createElement(t.Provider,{value:s},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/4bc002f8.8f763503.js b/assets/js/4bc002f8.8f763503.js
new file mode 100644
index 000000000..1af40be7d
--- /dev/null
+++ b/assets/js/4bc002f8.8f763503.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunklh_site=self.webpackChunklh_site||[]).push([[8488],{6603:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>f,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var r=t(4848),o=t(8453),a=t(1470),l=t(9365);const s={},i="Throwing Workflow Events",c={id:"developer-guide/wfspec-development/advanced/throwing-events",title:"Throwing Workflow Events",description:"Before you can add a THROW_EVENT Node to a WfSpec, you need to create a WorkflowEventDef metadata object in LittleHorse representing the event you want to throw. You can do that following our metadata management docs.",source:"@site/docs/05-developer-guide/08-wfspec-development/20-advanced/10-throwing-events.md",sourceDirName:"05-developer-guide/08-wfspec-development/20-advanced",slug:"/developer-guide/wfspec-development/advanced/throwing-events",permalink:"/docs/developer-guide/wfspec-development/advanced/throwing-events",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:10,frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Waiting for Conditions",permalink:"/docs/developer-guide/wfspec-development/advanced/wait-for-condition"},next:{title:"Using the LittleHorse API",permalink:"/docs/developer-guide/grpc/"}},d={},u=[{value:"Defining a THROW_EVENT Node",id:"defining-a-throw_event-node",level:2},{value:"Required Parameters",id:"required-parameters",level:3}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"throwing-workflow-events",children:"Throwing Workflow Events"})}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["Before you can add a ",(0,r.jsx)(n.code,{children:"THROW_EVENT"})," Node to a ",(0,r.jsx)(n.code,{children:"WfSpec"}),", you need to create a ",(0,r.jsx)(n.code,{children:"WorkflowEventDef"})," metadata object in LittleHorse representing the event you want to throw. You can do that following our ",(0,r.jsx)(n.a,{href:"/docs/developer-guide/grpc/managing-metadata#workfloweventdef",children:"metadata management docs"}),"."]})}),"\n",(0,r.jsxs)(n.p,{children:["To throw a WorkflowEvent in LittleHorse, you must define a ",(0,r.jsx)(n.code,{children:"THROW_EVENT"})," Node in a ",(0,r.jsx)(n.code,{children:"WfSpec"}),"."]}),"\n",(0,r.jsxs)(n.h2,{id:"defining-a-throw_event-node",children:["Defining a ",(0,r.jsx)(n.code,{children:"THROW_EVENT"})," Node"]}),"\n",(0,r.jsxs)(n.p,{children:["The following code defines a workflow that waits 5 seconds before throwing a ",(0,r.jsx)(n.code,{children:"WorkflowEvent"}),' named "my-event", with the content "Hello There!".']}),"\n","\n",(0,r.jsxs)(a.A,{children:[(0,r.jsx)(l.A,{value:"java",label:"Java",default:!0,children:(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-java",children:'public static Workflow getWorkflow() {\n return Workflow.newWorkflow(\n "throw-wf-event",\n wf -> {\n wf.sleepSeconds(5);\n wf.throwEvent("my-event", "Hello There!");\n });\n}\n'})})}),(0,r.jsx)(l.A,{value:"python",label:"Python",children:(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-python",children:'def get_workflow() -> Workflow:\n def my_entrypoint(wf: WorkflowThread) -> None:\n wf.sleep(5)\n wf.throwEvent("sleep-done", "Hello There!")\n\n return Workflow("throw-wf-event", my_entrypoint)\n'})})}),(0,r.jsx)(l.A,{value:"go",label:"Go",children:(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-go",children:'func ThrowWfEvent(wf *littlehorse.WorkflowThread) {\n wf.Sleep(5)\n wf.ThrowEvent("my-event", "Hello there!")\n}\n'})})})]}),"\n",(0,r.jsx)(n.h3,{id:"required-parameters",children:"Required Parameters"}),"\n",(0,r.jsx)(n.p,{children:"The two required values are:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"workflowEventDefName"})," is the Name of the ",(0,r.jsx)(n.code,{children:"WorkflowEventDef"})," that you want to throw a ",(0,r.jsx)(n.code,{children:"WorkflowEvent"})," for."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"content"})," is the content of the ",(0,r.jsx)(n.code,{children:"WorkflowEvent"})," that will be stored in the ",(0,r.jsx)(n.code,{children:"content"})," field of the ",(0,r.jsx)(n.code,{children:"WorkflowEvent"}),". Content type will match the ",(0,r.jsx)(n.code,{children:"VariableType"})," specified in your ",(0,r.jsx)(n.code,{children:"WorkflowEventDef"}),"."]}),"\n"]})]})}function f(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},9365:(e,n,t)=>{t.d(n,{A:()=>l});t(6540);var r=t(8215);const o={tabItem:"tabItem_Ymn6"};var a=t(4848);function l(e){let{children:n,hidden:t,className:l}=e;return(0,a.jsx)("div",{role:"tabpanel",className:(0,r.A)(o.tabItem,l),hidden:t,children:n})}},1470:(e,n,t)=>{t.d(n,{A:()=>y});var r=t(6540),o=t(8215),a=t(3104),l=t(6347),s=t(205),i=t(7485),c=t(1682),d=t(679);function u(e){return r.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,r.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad UserTaskRun Lifecycle",id:"usertaskrun-lifecycle",level:2},{value:"Search for UserTaskRuns",id:"search-for-usertaskruns",level:2},{value:"Display a UserTaskRun",id:"display-a-usertaskrun",level:2},{value:"Complete a UserTaskRun",id:"complete-a-usertaskrun",level:2},{value:"Save a UserTaskRun",id:"save-a-usertaskrun",level:2},{value:"Re-Assign a UserTaskRun",id:"re-assign-a-usertaskrun",level:2},{value:"Cancel a UserTaskRun",id:"cancel-a-usertaskrun",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"handling-user-tasks",children:"Handling User Tasks"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/docs/concepts/user-tasks",children:"User Tasks"})," enable a ",(0,t.jsx)(n.code,{children:"ThreadRun"})," to block until a human user provides some input into the workflow. Additionally, User Tasks have several useful hooks such as automatic reassignment, reminders, and auditing capabilities."]}),"\n",(0,t.jsxs)(n.p,{children:["This page shows you how to interact with a ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," on an already-running ",(0,t.jsx)(n.code,{children:"WfRun"}),"."]}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["For documentation about how to insert a ",(0,t.jsx)(n.code,{children:"USER_TASK"})," node into your ",(0,t.jsx)(n.code,{children:"WfSpec"}),", please refer to the ",(0,t.jsxs)(n.a,{href:"/docs/developer-guide/wfspec-development/user-tasks",children:[(0,t.jsx)(n.code,{children:"WfSpec"})," development documentation"]}),"."]})}),"\n",(0,t.jsx)(n.p,{children:"Note that LittleHorse does not provide an out-of-the-box implementation of a User Task Manager application. This is because it would likely be of limited use to our users, because the implementation of User Task Applications is highly use-case specific. For example, each of the following considerations might be handled vastly differently depending on the application:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Presentation:"})," is the user task form presented in a mobile app, standalone internal web application, or embedded into a customer-facing site?"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Identity Management:"})," what system is used to manage and determine the identity of the person executing User Tasks?"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Look and Feel:"})," what is the style of the actual page?"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Access Permisions:"})," while the ",(0,t.jsx)(n.code,{children:"userGroup"})," field of a ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," is useful for determining who may execute a ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),", how should the Task Manager application determine who can perform additional acctions, such as reassignment and viewing audit information?"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"While those considerations are left to the user of LittleHorse, User Tasks still provide an incredibly valuable tool to our users, specifically:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Direct integrations with the ",(0,t.jsx)(n.code,{children:"WfSpec"})]}),"\n",(0,t.jsx)(n.li,{children:"Built-in reassignment and reminder capabilities"}),"\n",(0,t.jsx)(n.li,{children:"Built-in search capabilities."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"This documentation explains everything you need in order to build your own application-specific User Tasks integration."}),"\n",(0,t.jsxs)(n.h2,{id:"usertaskrun-lifecycle",children:[(0,t.jsx)(n.code,{children:"UserTaskRun"})," Lifecycle"]}),"\n",(0,t.jsxs)(n.p,{children:["In order to use User Tasks, you must first create a ",(0,t.jsx)(n.code,{children:"WfSpec"})," that has a ",(0,t.jsx)(n.code,{children:"USER_TASK"})," node in it, for example by using the ",(0,t.jsx)(n.code,{children:"WorkflowThread#assignUserTask()"})," method (see our ",(0,t.jsxs)(n.a,{href:"/docs/developer-guide/wfspec-development/user-tasks",children:[(0,t.jsx)(n.code,{children:"WfSpec"})," Development Docs"]}),")."]}),"\n",(0,t.jsxs)(n.p,{children:["When a ",(0,t.jsx)(n.code,{children:"ThreadRun"})," arrives at such a ",(0,t.jsx)(n.code,{children:"Node"}),", then a ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," object is created in the LittleHorse Data Store. The ",(0,t.jsx)(n.code,{children:"ThreadRun"}),' will "block" at that ',(0,t.jsx)(n.code,{children:"Node"})," until the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," is either completed or cancelled. When the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," is completed, the ",(0,t.jsx)(n.code,{children:"NodeRun"})," returns an output which is a ",(0,t.jsx)(n.code,{children:"JSON_OBJ"})," containing a key-value pair for every field in the ",(0,t.jsx)(n.code,{children:"UserTaskDef"})," (in plain English, this is just one key-value for each field in the User Task form). When the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," is cancelled, an ",(0,t.jsx)(n.code,{children:"EXCEPTION"})," is propagated to the ",(0,t.jsx)(n.code,{children:"ThreadRun"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["The only way to Complete a ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," is via the ",(0,t.jsx)(n.code,{children:"rpc CompleteUserTaskRun"})," endpoint on the LH Server. A ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," may be cancelled either by the ",(0,t.jsx)(n.code,{children:"rpc CancelUserTaskRun"})," or by lifecycle hooks built-in to the ",(0,t.jsx)(n.code,{children:"WfSpec"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["A ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," may be in one of the four statuses below:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"UNASSIGNED"}),": the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," does not have a specific ",(0,t.jsx)(n.code,{children:"user_id"})," set. In this case, ",(0,t.jsx)(n.code,{children:"user_group"})," must be set."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"ASSIGNED"}),": the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," has a specific ",(0,t.jsx)(n.code,{children:"user_id"})," set, and may have a ",(0,t.jsx)(n.code,{children:"user_group"})," set as well."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"DONE"}),": the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," has been completed."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"CANCELLED"}),": the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," has been cancelled either by a manual ",(0,t.jsx)(n.code,{children:"rpc CancelUserTaskRun"})," or by a built-in User Task lifecycle hook."]}),"\n"]}),"\n",(0,t.jsxs)(n.h2,{id:"search-for-usertaskruns",children:["Search for ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"s"]}),"\n",(0,t.jsxs)(n.p,{children:["Before you can do anything useful with User Tasks, you need to be able to search for a list of ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s matching certain criteria. The endpoint ",(0,t.jsx)(n.code,{children:"rpc SearchUserTaskRun"})," allows you to do this."]}),"\n",(0,t.jsxs)(n.p,{children:["You can find the documentation for ",(0,t.jsx)(n.code,{children:"rpc SearchUserTaskRun"})," ",(0,t.jsx)(n.a,{href:"/docs/api#searchusertaskrun",children:"here in our API documentation"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"There are six filters that can be provided:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"status"}),": an enum of either ",(0,t.jsx)(n.code,{children:"DONE"}),", ",(0,t.jsx)(n.code,{children:"UNASSIGNED"}),", ",(0,t.jsx)(n.code,{children:"ASSIGNED"}),", or ",(0,t.jsx)(n.code,{children:"CANCELLED"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"user_task_def_name"}),": the name of the associated ",(0,t.jsx)(n.code,{children:"UserTaskDef"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"user_id"}),": Only returns ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s assigned to a specific user."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"user_group"}),": only returns ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s assigned to a group."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"earliest_start"}),": only returns ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s created after this date."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"latest_start"}),": only returns ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s created before this date."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["All fields are additive; meaning that you can specify any combination of the fields, and only ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s matching ",(0,t.jsx)(n.em,{children:"all"})," of the criteria will be"]}),"\n",(0,t.jsx)(n.admonition,{type:"info",children:(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"user_id"})," and ",(0,t.jsx)(n.code,{children:"user_group"})," fields are ",(0,t.jsx)(n.em,{children:"not"})," managed by LittleHorse. Rather, they are intended to allow the user of LittleHorse to pass values managed by an external identity provider. This allows User Tasks to support a wide array of identity management systems."]})}),"\n",(0,t.jsxs)(n.p,{children:["See below for an example of searching for ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s with the following criteria:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Assigned to the ",(0,t.jsx)(n.code,{children:"jedi-council"})," group, and specifically to be executed by ",(0,t.jsx)(n.code,{children:"obiwan"})]}),"\n",(0,t.jsx)(n.li,{children:"Created in the past week but at least 24 hours ago."}),"\n",(0,t.jsxs)(n.li,{children:["In the ",(0,t.jsx)(n.code,{children:"ASSIGNED"})," status."]}),"\n",(0,t.jsxs)(n.li,{children:["Of the type ",(0,t.jsx)(n.code,{children:"approve-funds-for-mission"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(i.A,{children:[(0,t.jsx)(o.A,{value:"java",label:"Java",default:!0,children:(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport java.time.Instant;\nimport java.time.temporal.ChronoUnit;\nimport com.google.protobuf.Timestamp;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.common.proto.SearchUserTaskRunRequest;\nimport io.littlehorse.sdk.common.proto.UserTaskRunIdList;\nimport io.littlehorse.sdk.common.proto.UserTaskRunStatus;\n\n\npublic class Main {\n public static void main(String[] args) throws IOException, InterruptedException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n Timestamp oneWeekAgo = Timestamp.newBuilder()\n .setSeconds(Instant.now().minus(7, ChronoUnit.DAYS).getEpochSecond())\n .build();\n\n Timestamp oneDayAgo = Timestamp.newBuilder()\n .setSeconds(Instant.now().minus(7, ChronoUnit.DAYS).getEpochSecond())\n .build();\n\n // You can omit certain search criteria here if desired. Only one criterion is needed\n // but you may provide as many criteria as you wish. This request shows all of the\n // available search criteria.\n //\n // Note that it is a paginated request as per the "Basics" section of our grpc docs.\n SearchUserTaskRunRequest req = SearchUserTaskRunRequest.newBuilder()\n .setUserId("obiwan")\n .setUserGroup("jedi-council")\n .setUserTaskDefName("it-request")\n .setStatus(UserTaskRunStatus.ASSIGNED)\n .setEarliestStart(oneWeekAgo)\n .setLatestStart(oneDayAgo)\n .build();\n\n UserTaskRunIdList results = client.searchUserTaskRun(req);\n System.out.println(LHLibUtil.protoToJson(results));\n\n // Omitted: process the UserTaskRunIdList, maybe using pagination.\n }\n}\n'})})}),(0,t.jsx)(o.A,{value:"go",label:"Go",children:(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-go",children:'package main\n\nimport (\n\t"context"\n\t"time"\n\n\t"github.com/littlehorse-enterprises/littlehorse/sdk-go/littlehorse"\n\t"github.com/littlehorse-enterprises/littlehorse/sdk-go/lhproto"\n\t"google.golang.org/protobuf/types/known/timestamppb"\n)\n\nfunc main() {\n\t// Get a client\n\tconfig := littlehorse.NewConfigFromEnv()\n\tclient, _ := config.GetGrpcClient()\n\n\toneWeekAgo := timestamppb.New(time.Now().Add(-7 * 24 * time.Hour))\n\toneDayAgo := timestamppb.New(time.Now().Add(-24 * time.Hour))\n\n\tuserTaskDefName := "it-request"\n\tuserGroup := "jedi-temple"\n\tuserId := "obi-wan"\n\tstatus := lhproto.UserTaskRunStatus_ASSIGNED\n\n\t// You may provide any or all of the following options. The only requirement\n\t// is that you must specify at least one criterion.\n\tsearchReq := &lhproto.SearchUserTaskRunRequest{\n\t\tUserTaskDefName: &userTaskDefName,\n\t\tUserId: &userId,\n\t\tUserGroup: &userGroup,\n\t\tStatus: &status,\n\t\tEarliestStart: oneWeekAgo,\n\t\tLatestStart: oneDayAgo,\n\t}\n\n\tresults, _ := (*client).SearchUserTaskRun(context.Background(), searchReq)\n\tlittlehorse.PrintProto(results)\n}\n'})})}),(0,t.jsx)(o.A,{value:"python",label:"Python",children:(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-python",children:'from littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom datetime import datetime, timedelta\nfrom google.protobuf.timestamp_pb2 import Timestamp\nfrom google.protobuf.json_format import MessageToJson\n\nconfig = LHConfig()\nclient = config.stub()\n\none_week_ago = Timestamp()\none_week_ago.FromDatetime(datetime.now() - timedelta(weeks=1))\n\none_day_ago = Timestamp()\none_day_ago.FromDatetime(datetime.now() - timedelta(days=1))\n\nresults: UserTaskRunIdList = client.SearchUserTaskRun(SearchUserTaskRunRequest(\n user_task_def_name="it-request",\n user_id="obiwan",\n user_group="jedi-council",\n status=UserTaskRunStatus.ASSIGNED,\n earliest_start=one_week_ago,\n latest_start=one_day_ago,\n))\n\nprint(MessageToJson(results))\n'})})})]}),"\n",(0,t.jsxs)(n.h2,{id:"display-a-usertaskrun",children:["Display a ",(0,t.jsx)(n.code,{children:"UserTaskRun"})]}),"\n",(0,t.jsxs)(n.p,{children:["Now that you've found some relevant ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s that you want to display in your application, how do you show them? This is particularly important to understand when building a generic User Task Manager."]}),"\n",(0,t.jsxs)(n.p,{children:["First, the ",(0,t.jsx)(n.code,{children:"rpc GetUserTaskRun"})," request can be used to get the details for of a ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),". To use this request, you need a ",(0,t.jsx)(n.code,{children:"UserTaskRunId"})," (see the note on searching above!)."]}),"\n",(0,t.jsxs)(n.p,{children:["Once you have the ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),", you can inspect the results (if it's already completed). If you are trying to develop a frontend to execute the ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),", you can iterate through the ",(0,t.jsx)(n.code,{children:"fields"})," of the ",(0,t.jsx)(n.code,{children:"UserTaskDef"})," and determine what fields are to be displayed."]}),"\n",(0,t.jsxs)(i.A,{children:[(0,t.jsx)(o.A,{value:"java",label:"Java",default:!0,children:(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport java.util.Map;\n\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.common.proto.UserTaskDef;\nimport io.littlehorse.sdk.common.proto.UserTaskField;\nimport io.littlehorse.sdk.common.proto.UserTaskRun;\nimport io.littlehorse.sdk.common.proto.UserTaskRunId;\nimport io.littlehorse.sdk.common.proto.UserTaskRunStatus;\nimport io.littlehorse.sdk.common.proto.VariableValue;\nimport io.littlehorse.sdk.common.proto.WfRunId;\n\n\npublic class Main {\n public static void main(String[] args) throws IOException, InterruptedException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n // Get a UserTaskRunId somehow. For example, you could search for one as shown\n // in the section above.\n UserTaskRunId id = UserTaskRunId.newBuilder()\n .setWfRunId(WfRunId.newBuilder().setId("e0e49b53298a4965b059a1a5df095b09"))\n .setUserTaskGuid("8bb5d43e14894c82bb1deab7a68b32ae")\n .build();\n\n // Fetch the UserTaskRun\n UserTaskRun userTaskRun = client.getUserTaskRun(id);\n\n // See the current owners\n String userId = userTaskRun.hasUserId() ? userTaskRun.getUserId() : null;\n String userGroup = userTaskRun.hasUserGroup() ? userTaskRun.getUserGroup() : null;\n System.out.println(\n "The UserTaskRun is assigned to group \'%s\' and user \'%s\'".formatted(userGroup, userId));\n\n // In order to see the fields, you need to fetch the `UserTaskDef`.\n UserTaskDef utd = client.getUserTaskDef(userTaskRun.getUserTaskDefId());\n for (UserTaskField field : utd.getFieldsList()) {\n System.out.println("Field %s has type %s".formatted(field.getName(), field.getType()));\n }\n\n // If the UserTaskRun is in the `DONE` state, it will have `results`.\n if (userTaskRun.getStatus() == UserTaskRunStatus.DONE) {\n for (Map.EntryUserTaskRun Lifecycle",id:"usertaskrun-lifecycle",level:2},{value:"Search for UserTaskRuns",id:"search-for-usertaskruns",level:2},{value:"Display a UserTaskRun",id:"display-a-usertaskrun",level:2},{value:"Complete a UserTaskRun",id:"complete-a-usertaskrun",level:2},{value:"Save a UserTaskRun",id:"save-a-usertaskrun",level:2},{value:"Re-Assign a UserTaskRun",id:"re-assign-a-usertaskrun",level:2},{value:"Cancel a UserTaskRun",id:"cancel-a-usertaskrun",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"handling-user-tasks",children:"Handling User Tasks"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/docs/concepts/user-tasks",children:"User Tasks"})," enable a ",(0,t.jsx)(n.code,{children:"ThreadRun"})," to block until a human user provides some input into the workflow. Additionally, User Tasks have several useful hooks such as automatic reassignment, reminders, and auditing capabilities."]}),"\n",(0,t.jsxs)(n.p,{children:["This page shows you how to interact with a ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," on an already-running ",(0,t.jsx)(n.code,{children:"WfRun"}),"."]}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["For documentation about how to insert a ",(0,t.jsx)(n.code,{children:"USER_TASK"})," node into your ",(0,t.jsx)(n.code,{children:"WfSpec"}),", please refer to the ",(0,t.jsxs)(n.a,{href:"/docs/developer-guide/wfspec-development/user-tasks",children:[(0,t.jsx)(n.code,{children:"WfSpec"})," development documentation"]}),"."]})}),"\n",(0,t.jsx)(n.p,{children:"Note that LittleHorse does not provide an out-of-the-box implementation of a User Task Manager application. This is because it would likely be of limited use to our users, because the implementation of User Task Applications is highly use-case specific. For example, each of the following considerations might be handled vastly differently depending on the application:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Presentation:"})," is the user task form presented in a mobile app, standalone internal web application, or embedded into a customer-facing site?"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Identity Management:"})," what system is used to manage and determine the identity of the person executing User Tasks?"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Look and Feel:"})," what is the style of the actual page?"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Access Permisions:"})," while the ",(0,t.jsx)(n.code,{children:"userGroup"})," field of a ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," is useful for determining who may execute a ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),", how should the Task Manager application determine who can perform additional acctions, such as reassignment and viewing audit information?"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"While those considerations are left to the user of LittleHorse, User Tasks still provide an incredibly valuable tool to our users, specifically:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Direct integrations with the ",(0,t.jsx)(n.code,{children:"WfSpec"})]}),"\n",(0,t.jsx)(n.li,{children:"Built-in reassignment and reminder capabilities"}),"\n",(0,t.jsx)(n.li,{children:"Built-in search capabilities."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"This documentation explains everything you need in order to build your own application-specific User Tasks integration."}),"\n",(0,t.jsxs)(n.h2,{id:"usertaskrun-lifecycle",children:[(0,t.jsx)(n.code,{children:"UserTaskRun"})," Lifecycle"]}),"\n",(0,t.jsxs)(n.p,{children:["In order to use User Tasks, you must first create a ",(0,t.jsx)(n.code,{children:"WfSpec"})," that has a ",(0,t.jsx)(n.code,{children:"USER_TASK"})," node in it, for example by using the ",(0,t.jsx)(n.code,{children:"WorkflowThread#assignUserTask()"})," method (see our ",(0,t.jsxs)(n.a,{href:"/docs/developer-guide/wfspec-development/user-tasks",children:[(0,t.jsx)(n.code,{children:"WfSpec"})," Development Docs"]}),")."]}),"\n",(0,t.jsxs)(n.p,{children:["When a ",(0,t.jsx)(n.code,{children:"ThreadRun"})," arrives at such a ",(0,t.jsx)(n.code,{children:"Node"}),", then a ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," object is created in the LittleHorse Data Store. The ",(0,t.jsx)(n.code,{children:"ThreadRun"}),' will "block" at that ',(0,t.jsx)(n.code,{children:"Node"})," until the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," is either completed or cancelled. When the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," is completed, the ",(0,t.jsx)(n.code,{children:"NodeRun"})," returns an output which is a ",(0,t.jsx)(n.code,{children:"JSON_OBJ"})," containing a key-value pair for every field in the ",(0,t.jsx)(n.code,{children:"UserTaskDef"})," (in plain English, this is just one key-value for each field in the User Task form). When the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," is cancelled, an ",(0,t.jsx)(n.code,{children:"EXCEPTION"})," is propagated to the ",(0,t.jsx)(n.code,{children:"ThreadRun"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["The only way to Complete a ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," is via the ",(0,t.jsx)(n.code,{children:"rpc CompleteUserTaskRun"})," endpoint on the LH Server. A ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," may be cancelled either by the ",(0,t.jsx)(n.code,{children:"rpc CancelUserTaskRun"})," or by lifecycle hooks built-in to the ",(0,t.jsx)(n.code,{children:"WfSpec"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["A ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," may be in one of the four statuses below:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"UNASSIGNED"}),": the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," does not have a specific ",(0,t.jsx)(n.code,{children:"user_id"})," set. In this case, ",(0,t.jsx)(n.code,{children:"user_group"})," must be set."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"ASSIGNED"}),": the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," has a specific ",(0,t.jsx)(n.code,{children:"user_id"})," set, and may have a ",(0,t.jsx)(n.code,{children:"user_group"})," set as well."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"DONE"}),": the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," has been completed."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"CANCELLED"}),": the ",(0,t.jsx)(n.code,{children:"UserTaskRun"})," has been cancelled either by a manual ",(0,t.jsx)(n.code,{children:"rpc CancelUserTaskRun"})," or by a built-in User Task lifecycle hook."]}),"\n"]}),"\n",(0,t.jsxs)(n.h2,{id:"search-for-usertaskruns",children:["Search for ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"s"]}),"\n",(0,t.jsxs)(n.p,{children:["Before you can do anything useful with User Tasks, you need to be able to search for a list of ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s matching certain criteria. The endpoint ",(0,t.jsx)(n.code,{children:"rpc SearchUserTaskRun"})," allows you to do this."]}),"\n",(0,t.jsxs)(n.p,{children:["You can find the documentation for ",(0,t.jsx)(n.code,{children:"rpc SearchUserTaskRun"})," ",(0,t.jsx)(n.a,{href:"/docs/api#searchusertaskrun",children:"here in our API documentation"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"There are six filters that can be provided:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"status"}),": an enum of either ",(0,t.jsx)(n.code,{children:"DONE"}),", ",(0,t.jsx)(n.code,{children:"UNASSIGNED"}),", ",(0,t.jsx)(n.code,{children:"ASSIGNED"}),", or ",(0,t.jsx)(n.code,{children:"CANCELLED"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"user_task_def_name"}),": the name of the associated ",(0,t.jsx)(n.code,{children:"UserTaskDef"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"user_id"}),": Only returns ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s assigned to a specific user."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"user_group"}),": only returns ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s assigned to a group."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"earliest_start"}),": only returns ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s created after this date."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"latest_start"}),": only returns ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s created before this date."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["All fields are additive; meaning that you can specify any combination of the fields, and only ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s matching ",(0,t.jsx)(n.em,{children:"all"})," of the criteria will be"]}),"\n",(0,t.jsx)(n.admonition,{type:"info",children:(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"user_id"})," and ",(0,t.jsx)(n.code,{children:"user_group"})," fields are ",(0,t.jsx)(n.em,{children:"not"})," managed by LittleHorse. Rather, they are intended to allow the user of LittleHorse to pass values managed by an external identity provider. This allows User Tasks to support a wide array of identity management systems."]})}),"\n",(0,t.jsxs)(n.p,{children:["See below for an example of searching for ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s with the following criteria:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Assigned to the ",(0,t.jsx)(n.code,{children:"jedi-council"})," group, and specifically to be executed by ",(0,t.jsx)(n.code,{children:"obiwan"})]}),"\n",(0,t.jsx)(n.li,{children:"Created in the past week but at least 24 hours ago."}),"\n",(0,t.jsxs)(n.li,{children:["In the ",(0,t.jsx)(n.code,{children:"ASSIGNED"})," status."]}),"\n",(0,t.jsxs)(n.li,{children:["Of the type ",(0,t.jsx)(n.code,{children:"approve-funds-for-mission"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(i.A,{children:[(0,t.jsx)(o.A,{value:"java",label:"Java",default:!0,children:(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport java.time.Instant;\nimport java.time.temporal.ChronoUnit;\nimport com.google.protobuf.Timestamp;\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.common.proto.SearchUserTaskRunRequest;\nimport io.littlehorse.sdk.common.proto.UserTaskRunIdList;\nimport io.littlehorse.sdk.common.proto.UserTaskRunStatus;\n\n\npublic class Main {\n public static void main(String[] args) throws IOException, InterruptedException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n Timestamp oneWeekAgo = Timestamp.newBuilder()\n .setSeconds(Instant.now().minus(7, ChronoUnit.DAYS).getEpochSecond())\n .build();\n\n Timestamp oneDayAgo = Timestamp.newBuilder()\n .setSeconds(Instant.now().minus(7, ChronoUnit.DAYS).getEpochSecond())\n .build();\n\n // You can omit certain search criteria here if desired. Only one criterion is needed\n // but you may provide as many criteria as you wish. This request shows all of the\n // available search criteria.\n //\n // Note that it is a paginated request as per the "Basics" section of our grpc docs.\n SearchUserTaskRunRequest req = SearchUserTaskRunRequest.newBuilder()\n .setUserId("obiwan")\n .setUserGroup("jedi-council")\n .setUserTaskDefName("it-request")\n .setStatus(UserTaskRunStatus.ASSIGNED)\n .setEarliestStart(oneWeekAgo)\n .setLatestStart(oneDayAgo)\n .build();\n\n UserTaskRunIdList results = client.searchUserTaskRun(req);\n System.out.println(LHLibUtil.protoToJson(results));\n\n // Omitted: process the UserTaskRunIdList, maybe using pagination.\n }\n}\n'})})}),(0,t.jsx)(o.A,{value:"go",label:"Go",children:(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-go",children:'package main\n\nimport (\n\t"context"\n\t"time"\n\n\t"github.com/littlehorse-enterprises/littlehorse/sdk-go/littlehorse"\n\t"github.com/littlehorse-enterprises/littlehorse/sdk-go/lhproto"\n\t"google.golang.org/protobuf/types/known/timestamppb"\n)\n\nfunc main() {\n\t// Get a client\n\tconfig := littlehorse.NewConfigFromEnv()\n\tclient, _ := config.GetGrpcClient()\n\n\toneWeekAgo := timestamppb.New(time.Now().Add(-7 * 24 * time.Hour))\n\toneDayAgo := timestamppb.New(time.Now().Add(-24 * time.Hour))\n\n\tuserTaskDefName := "it-request"\n\tuserGroup := "jedi-temple"\n\tuserId := "obi-wan"\n\tstatus := lhproto.UserTaskRunStatus_ASSIGNED\n\n\t// You may provide any or all of the following options. The only requirement\n\t// is that you must specify at least one criterion.\n\tsearchReq := &lhproto.SearchUserTaskRunRequest{\n\t\tUserTaskDefName: &userTaskDefName,\n\t\tUserId: &userId,\n\t\tUserGroup: &userGroup,\n\t\tStatus: &status,\n\t\tEarliestStart: oneWeekAgo,\n\t\tLatestStart: oneDayAgo,\n\t}\n\n\tresults, _ := (*client).SearchUserTaskRun(context.Background(), searchReq)\n\tlittlehorse.PrintProto(results)\n}\n'})})}),(0,t.jsx)(o.A,{value:"python",label:"Python",children:(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-python",children:'from littlehorse.config import LHConfig\nfrom littlehorse.model import *\nfrom datetime import datetime, timedelta\nfrom google.protobuf.timestamp_pb2 import Timestamp\nfrom google.protobuf.json_format import MessageToJson\n\nconfig = LHConfig()\nclient = config.stub()\n\none_week_ago = Timestamp()\none_week_ago.FromDatetime(datetime.now() - timedelta(weeks=1))\n\none_day_ago = Timestamp()\none_day_ago.FromDatetime(datetime.now() - timedelta(days=1))\n\nresults: UserTaskRunIdList = client.SearchUserTaskRun(SearchUserTaskRunRequest(\n user_task_def_name="it-request",\n user_id="obiwan",\n user_group="jedi-council",\n status=UserTaskRunStatus.ASSIGNED,\n earliest_start=one_week_ago,\n latest_start=one_day_ago,\n))\n\nprint(MessageToJson(results))\n'})})})]}),"\n",(0,t.jsxs)(n.h2,{id:"display-a-usertaskrun",children:["Display a ",(0,t.jsx)(n.code,{children:"UserTaskRun"})]}),"\n",(0,t.jsxs)(n.p,{children:["Now that you've found some relevant ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),"'s that you want to display in your application, how do you show them? This is particularly important to understand when building a generic User Task Manager."]}),"\n",(0,t.jsxs)(n.p,{children:["First, the ",(0,t.jsx)(n.code,{children:"rpc GetUserTaskRun"})," request can be used to get the details for of a ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),". To use this request, you need a ",(0,t.jsx)(n.code,{children:"UserTaskRunId"})," (see the note on searching above!)."]}),"\n",(0,t.jsxs)(n.p,{children:["Once you have the ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),", you can inspect the results (if it's already completed). If you are trying to develop a frontend to execute the ",(0,t.jsx)(n.code,{children:"UserTaskRun"}),", you can iterate through the ",(0,t.jsx)(n.code,{children:"fields"})," of the ",(0,t.jsx)(n.code,{children:"UserTaskDef"})," and determine what fields are to be displayed."]}),"\n",(0,t.jsxs)(i.A,{children:[(0,t.jsx)(o.A,{value:"java",label:"Java",default:!0,children:(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-java",children:'package io.littlehorse.quickstart;\n\nimport java.io.IOException;\nimport java.util.Map;\n\nimport io.littlehorse.sdk.common.LHLibUtil;\nimport io.littlehorse.sdk.common.config.LHConfig;\nimport io.littlehorse.sdk.common.proto.LittleHorseGrpc.LittleHorseBlockingStub;\nimport io.littlehorse.sdk.common.proto.UserTaskDef;\nimport io.littlehorse.sdk.common.proto.UserTaskField;\nimport io.littlehorse.sdk.common.proto.UserTaskRun;\nimport io.littlehorse.sdk.common.proto.UserTaskRunId;\nimport io.littlehorse.sdk.common.proto.UserTaskRunStatus;\nimport io.littlehorse.sdk.common.proto.VariableValue;\nimport io.littlehorse.sdk.common.proto.WfRunId;\n\n\npublic class Main {\n public static void main(String[] args) throws IOException, InterruptedException {\n LHConfig config = new LHConfig();\n LittleHorseBlockingStub client = config.getBlockingStub();\n\n // Get a UserTaskRunId somehow. For example, you could search for one as shown\n // in the section above.\n UserTaskRunId id = UserTaskRunId.newBuilder()\n .setWfRunId(WfRunId.newBuilder().setId("e0e49b53298a4965b059a1a5df095b09"))\n .setUserTaskGuid("8bb5d43e14894c82bb1deab7a68b32ae")\n .build();\n\n // Fetch the UserTaskRun\n UserTaskRun userTaskRun = client.getUserTaskRun(id);\n\n // See the current owners\n String userId = userTaskRun.hasUserId() ? userTaskRun.getUserId() : null;\n String userGroup = userTaskRun.hasUserGroup() ? userTaskRun.getUserGroup() : null;\n System.out.println(\n "The UserTaskRun is assigned to group \'%s\' and user \'%s\'".formatted(userGroup, userId));\n\n // In order to see the fields, you need to fetch the `UserTaskDef`.\n UserTaskDef utd = client.getUserTaskDef(userTaskRun.getUserTaskDefId());\n for (UserTaskField field : utd.getFieldsList()) {\n System.out.println("Field %s has type %s".formatted(field.getName(), field.getType()));\n }\n\n // If the UserTaskRun is in the `DONE` state, it will have `results`.\n if (userTaskRun.getStatus() == UserTaskRunStatus.DONE) {\n for (Map.EntryYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n