nominal_api/proto/
nominal.procedures.executions.v1.rs

1// This file is @generated by prost-build.
2/// A procedure execution node is either a section or a step.
3#[derive(Clone, PartialEq, ::prost::Message)]
4pub struct ProcedureExecutionNode {
5    #[prost(oneof = "procedure_execution_node::Node", tags = "1, 2")]
6    pub node: ::core::option::Option<procedure_execution_node::Node>,
7}
8/// Nested message and enum types in `ProcedureExecutionNode`.
9pub mod procedure_execution_node {
10    #[derive(Clone, PartialEq, ::prost::Oneof)]
11    pub enum Node {
12        /// A section node is a visual grouping of other sections and steps.
13        /// Execution sections are static and do not have execution state.
14        #[prost(message, tag = "1")]
15        Section(super::ProcedureExecutionSectionNode),
16        /// Execution steps are the interactive steps in a procedure.
17        #[prost(message, tag = "2")]
18        Step(super::ProcedureExecutionStepNode),
19    }
20}
21/// A section node is a visual grouping of other sections and steps.
22#[derive(Clone, PartialEq, ::prost::Message)]
23pub struct ProcedureExecutionSectionNode {
24    /// Unique identifier of this execution node.
25    #[prost(string, tag = "1")]
26    pub id: ::prost::alloc::string::String,
27    /// Unique identifier of the template node this execution node is based on.
28    #[prost(string, tag = "2")]
29    pub template_node_id: ::prost::alloc::string::String,
30    /// Title of this section. Uses the template section's title and cannot be changed in execution.
31    #[prost(string, tag = "3")]
32    pub title: ::prost::alloc::string::String,
33    /// Description of this section. Uses the template section's description and cannot be changed in execution.
34    #[prost(string, optional, tag = "4")]
35    pub description: ::core::option::Option<::prost::alloc::string::String>,
36    /// If set, the commit ID of the procedure template this section is based on.
37    /// Otherwise, the section is based on the template commit specified at the top level of the execution.
38    #[prost(string, optional, tag = "5")]
39    pub template_commit_id: ::core::option::Option<::prost::alloc::string::String>,
40}
41/// Execution steps are the interactive steps in a procedure.
42#[derive(Clone, PartialEq, ::prost::Message)]
43pub struct ProcedureExecutionStepNode {
44    /// Unique identifier of this execution node.
45    #[prost(string, tag = "1")]
46    pub id: ::prost::alloc::string::String,
47    /// Unique identifier of the template node this execution node is based on.
48    #[prost(string, tag = "2")]
49    pub template_node_id: ::prost::alloc::string::String,
50    /// Execution steps become "outdated" once any upstream steps are re-run
51    /// An outdated execution step should not be further modified.
52    #[prost(bool, tag = "3")]
53    pub is_outdated: bool,
54    /// The current status of the step along with metadata about the status transitions.
55    #[prost(message, optional, tag = "4")]
56    pub state: ::core::option::Option<ExecutionStepState>,
57    /// The current value for the content of the step.
58    #[prost(message, optional, tag = "5")]
59    pub value: ::core::option::Option<StepContentValue>,
60    /// Whether the step has auto-proceed enabled.
61    #[prost(message, optional, tag = "6")]
62    pub auto_proceed_config: ::core::option::Option<super::super::v1::AutoProceedConfig>,
63    /// Completion_condition_status is the status of the completion condition for the step
64    /// The backend manages this property and will update it while it monitors the
65    /// completion_condition if set.
66    /// This property will be unset if no completion_condition is set on the step or
67    /// if the execution step's contents has not been submitted yet.
68    #[prost(message, optional, tag = "7")]
69    pub success_condition_status: ::core::option::Option<SuccessConditionStatus>,
70    /// Completion_action_statuses are the status of the completion actions for the step
71    /// The backend manages this property and will update it after performing
72    /// completion_actions.
73    #[prost(message, repeated, tag = "8")]
74    pub completion_action_statuses: ::prost::alloc::vec::Vec<CompletionActionStatus>,
75    /// Outputs are the values of the fields within this step, set by the backend after the step has reached
76    /// the SUCCEEDED state.
77    /// The backend will know how to introspect the node and determine these values, for example looking for
78    /// form fields with ids in a FormStep.
79    /// These outputs can be consumed by other steps later in the procedure by referencing `{output_id}:{field_id}`
80    #[prost(map = "string, message", tag = "10")]
81    pub outputs: ::std::collections::HashMap<
82        ::prost::alloc::string::String,
83        FieldOutput,
84    >,
85    /// If set, the commit ID of the procedure template this step is based on.
86    /// Otherwise, the step is based on the template commit specified at the top level of the execution.
87    #[prost(string, optional, tag = "11")]
88    pub template_commit_id: ::core::option::Option<::prost::alloc::string::String>,
89}
90/// All execution steps start in the NOT_STARTED state.
91/// In this state, the step's values can be modified by the user.
92#[derive(Clone, Copy, PartialEq, ::prost::Message)]
93pub struct ExecutionStepNotStarted {}
94/// An execution step is in the SKIPPED state if it was skipped by a user.
95/// An execution step cannot be skipped if it is in a terminal state (SUCCEEDED or ERRORED).
96/// This is a terminal state, the step's values cannot be modified by the user.
97#[derive(Clone, PartialEq, ::prost::Message)]
98pub struct ExecutionStepSkipped {
99    #[prost(message, optional, tag = "1")]
100    pub skipped_at: ::core::option::Option<
101        super::super::super::super::google::protobuf::Timestamp,
102    >,
103    #[prost(string, tag = "2")]
104    pub skipped_by: ::prost::alloc::string::String,
105    #[prost(string, optional, tag = "3")]
106    pub skip_reason: ::core::option::Option<::prost::alloc::string::String>,
107    /// Optional because a step can be skipped from the NOT_STARTED state before these are set
108    #[prost(message, optional, tag = "4")]
109    pub started_at: ::core::option::Option<
110        super::super::super::super::google::protobuf::Timestamp,
111    >,
112    #[prost(string, optional, tag = "5")]
113    pub started_by: ::core::option::Option<::prost::alloc::string::String>,
114    /// Optional because a step can be skipped from the IN_PROGRESS state before these are set
115    #[prost(message, optional, tag = "6")]
116    pub submitted_at: ::core::option::Option<
117        super::super::super::super::google::protobuf::Timestamp,
118    >,
119    #[prost(string, optional, tag = "7")]
120    pub submitted_by: ::core::option::Option<::prost::alloc::string::String>,
121}
122/// An execution step is in the IN_PROGRESS state once it has been started from NOT_STARTED,
123/// either manually or automatically.
124/// In this state, the step's values can be modified by the user.
125#[derive(Clone, PartialEq, ::prost::Message)]
126pub struct ExecutionStepInProgress {
127    #[prost(message, optional, tag = "1")]
128    pub started_at: ::core::option::Option<
129        super::super::super::super::google::protobuf::Timestamp,
130    >,
131    #[prost(string, tag = "2")]
132    pub started_by: ::prost::alloc::string::String,
133}
134/// An execution step is in the SUBMITTED state once it has been submitted from the IN_PROGRESS state,
135/// either manually or automatically.
136/// In this state, the step's values are considered submitted and cannot be modified by the user.
137/// In this state, the backend will monitor the completion condition (if any) and execute the completion
138/// actions (if any) once the condition is satisfied.
139#[derive(Clone, PartialEq, ::prost::Message)]
140pub struct ExecutionStepSubmitted {
141    #[prost(message, optional, tag = "1")]
142    pub started_at: ::core::option::Option<
143        super::super::super::super::google::protobuf::Timestamp,
144    >,
145    #[prost(string, tag = "2")]
146    pub started_by: ::prost::alloc::string::String,
147    #[prost(message, optional, tag = "3")]
148    pub submitted_at: ::core::option::Option<
149        super::super::super::super::google::protobuf::Timestamp,
150    >,
151    #[prost(string, tag = "4")]
152    pub submitted_by: ::prost::alloc::string::String,
153}
154/// An execution step reaches the SUCCEEDED state if all conditions were met and all actions successfully ran.
155/// This is a terminal state, the step's values cannot be modified by the user.
156#[derive(Clone, PartialEq, ::prost::Message)]
157pub struct ExecutionStepSucceeded {
158    #[prost(message, optional, tag = "1")]
159    pub started_at: ::core::option::Option<
160        super::super::super::super::google::protobuf::Timestamp,
161    >,
162    #[prost(string, tag = "2")]
163    pub started_by: ::prost::alloc::string::String,
164    #[prost(message, optional, tag = "3")]
165    pub submitted_at: ::core::option::Option<
166        super::super::super::super::google::protobuf::Timestamp,
167    >,
168    #[prost(string, tag = "4")]
169    pub submitted_by: ::prost::alloc::string::String,
170    #[prost(message, optional, tag = "5")]
171    pub succeeded_at: ::core::option::Option<
172        super::super::super::super::google::protobuf::Timestamp,
173    >,
174    #[prost(string, tag = "6")]
175    pub succeeded_by: ::prost::alloc::string::String,
176}
177/// An execution step reaches the ERRORED state if something went wrong while trying to complete the step.
178/// This could be due to a badly configured procedure, an error/timeout in the completion condition,
179/// or an error/timeout in one of the completion actions.
180/// This is a terminal state, the step's values cannot be modified by the user.
181#[derive(Clone, PartialEq, ::prost::Message)]
182pub struct ExecutionStepErrored {
183    /// Optinal because a step can be skipped -> errored before being started
184    #[prost(message, optional, tag = "1")]
185    pub started_at: ::core::option::Option<
186        super::super::super::super::google::protobuf::Timestamp,
187    >,
188    #[prost(string, optional, tag = "2")]
189    pub started_by: ::core::option::Option<::prost::alloc::string::String>,
190    /// Optional because a step can be errored before being submitted
191    #[prost(message, optional, tag = "3")]
192    pub submitted_at: ::core::option::Option<
193        super::super::super::super::google::protobuf::Timestamp,
194    >,
195    #[prost(string, optional, tag = "4")]
196    pub submitted_by: ::core::option::Option<::prost::alloc::string::String>,
197    #[prost(message, optional, tag = "5")]
198    pub errored_at: ::core::option::Option<
199        super::super::super::super::google::protobuf::Timestamp,
200    >,
201    #[prost(string, tag = "6")]
202    pub errored_by: ::prost::alloc::string::String,
203    #[prost(string, tag = "7")]
204    pub error: ::prost::alloc::string::String,
205    /// Optional because a step could be skipped but then error while running completion actions
206    #[prost(message, optional, tag = "8")]
207    pub skipped_at: ::core::option::Option<
208        super::super::super::super::google::protobuf::Timestamp,
209    >,
210    #[prost(string, optional, tag = "9")]
211    pub skipped_by: ::core::option::Option<::prost::alloc::string::String>,
212    #[prost(string, optional, tag = "10")]
213    pub skip_reason: ::core::option::Option<::prost::alloc::string::String>,
214    /// Optional because a step can succeed but then error while running completion actions
215    #[prost(message, optional, tag = "11")]
216    pub succeeded_at: ::core::option::Option<
217        super::super::super::super::google::protobuf::Timestamp,
218    >,
219    #[prost(string, optional, tag = "12")]
220    pub succeeded_by: ::core::option::Option<::prost::alloc::string::String>,
221}
222/// The read-side state for an execution step.
223/// Here is the state machine:
224/// All steps start in the NOT_STARTED state.
225/// From NOT_STARTED, a step can transition to IN_PROGRESS or SKIPPED.
226/// - Transitioning to IN_PROGRESS can be done manually by a user or automatically if auto-start is enabled.
227///    This transition can only happen if the step's dependencies are in a completed state (SUCCEEDED or SKIPPED)
228/// From IN_PROGRESS, a step can transition to SUBMITTED or SKIPPED.
229/// - Transitioning to SUBMITTED can be done manually by a user or automatically if auto-proceed is enabled.
230///    This transition can only happen if the step's content has its required values set.
231/// - Transitioning to SKIPPED can be done manually by a user.
232/// From SUBMITTED, a step can transition to SUCCEEDED, ERRORED, or SKIPPED.
233/// - Transitioning to SUCCEEDED or ERRORED is done by the backend after monitoring the completion
234///    condition (if any) and executing the completion actions (if any).
235/// - Transitioning to SKIPPED can be done manually by a user.
236#[derive(Clone, PartialEq, ::prost::Message)]
237pub struct ExecutionStepState {
238    #[prost(oneof = "execution_step_state::State", tags = "1, 2, 3, 4, 5, 6")]
239    pub state: ::core::option::Option<execution_step_state::State>,
240}
241/// Nested message and enum types in `ExecutionStepState`.
242pub mod execution_step_state {
243    #[derive(Clone, PartialEq, ::prost::Oneof)]
244    pub enum State {
245        #[prost(message, tag = "1")]
246        NotStarted(super::ExecutionStepNotStarted),
247        #[prost(message, tag = "2")]
248        InProgress(super::ExecutionStepInProgress),
249        #[prost(message, tag = "3")]
250        Submitted(super::ExecutionStepSubmitted),
251        /// Terminal states below
252        #[prost(message, tag = "4")]
253        Skipped(super::ExecutionStepSkipped),
254        #[prost(message, tag = "5")]
255        Succeeded(super::ExecutionStepSucceeded),
256        #[prost(message, tag = "6")]
257        Errored(super::ExecutionStepErrored),
258    }
259}
260#[derive(Clone, Copy, PartialEq, ::prost::Message)]
261pub struct StepInProgressRequest {}
262#[derive(Clone, Copy, PartialEq, ::prost::Message)]
263pub struct StepSubmittedRequest {}
264#[derive(Clone, PartialEq, ::prost::Message)]
265pub struct StepSkippedRequest {
266    #[prost(string, optional, tag = "1")]
267    pub skip_reason: ::core::option::Option<::prost::alloc::string::String>,
268}
269#[derive(Clone, PartialEq, ::prost::Message)]
270pub struct StepErroredRequest {
271    #[prost(string, optional, tag = "1")]
272    pub error_reason: ::core::option::Option<::prost::alloc::string::String>,
273}
274/// A request to update the state of an execution step.
275#[derive(Clone, PartialEq, ::prost::Message)]
276pub struct TargetStepStateRequest {
277    #[prost(oneof = "target_step_state_request::TargetState", tags = "1, 2, 3, 4")]
278    pub target_state: ::core::option::Option<target_step_state_request::TargetState>,
279}
280/// Nested message and enum types in `TargetStepStateRequest`.
281pub mod target_step_state_request {
282    #[derive(Clone, PartialEq, ::prost::Oneof)]
283    pub enum TargetState {
284        #[prost(message, tag = "1")]
285        InProgress(super::StepInProgressRequest),
286        #[prost(message, tag = "2")]
287        Submitted(super::StepSubmittedRequest),
288        #[prost(message, tag = "3")]
289        Skipped(super::StepSkippedRequest),
290        #[prost(message, tag = "4")]
291        Errored(super::StepErroredRequest),
292    }
293}
294#[derive(Clone, PartialEq, ::prost::Message)]
295pub struct ProcedureAsyncTask {
296    #[prost(oneof = "procedure_async_task::Task", tags = "1")]
297    pub task: ::core::option::Option<procedure_async_task::Task>,
298}
299/// Nested message and enum types in `ProcedureAsyncTask`.
300pub mod procedure_async_task {
301    #[derive(Clone, PartialEq, ::prost::Oneof)]
302    pub enum Task {
303        #[prost(message, tag = "1")]
304        ConditionObservation(super::ConditionObservation),
305    }
306}
307#[derive(Clone, PartialEq, ::prost::Message)]
308pub struct ConditionObservation {
309    #[prost(string, tag = "1")]
310    pub user_rid: ::prost::alloc::string::String,
311    #[prost(string, tag = "2")]
312    pub org_rid: ::prost::alloc::string::String,
313    #[prost(string, tag = "3")]
314    pub procedure_execution_rid: ::prost::alloc::string::String,
315    #[prost(string, tag = "4")]
316    pub step_id: ::prost::alloc::string::String,
317    #[prost(message, optional, tag = "5")]
318    pub success_condition: ::core::option::Option<super::super::v1::SuccessCondition>,
319}
320/// Represents the current status of one or more nested completion conditions.
321/// Mirrors the recursive SuccessCondition in nominal.procedures.v1
322#[derive(Clone, PartialEq, ::prost::Message)]
323pub struct SuccessConditionStatus {
324    /// The type of condition being monitored.
325    #[prost(oneof = "success_condition_status::Condition", tags = "1, 6, 7")]
326    pub condition: ::core::option::Option<success_condition_status::Condition>,
327    /// The status of this condition.
328    #[prost(oneof = "success_condition_status::Status", tags = "2, 3, 4, 5, 8")]
329    pub status: ::core::option::Option<success_condition_status::Status>,
330}
331/// Nested message and enum types in `SuccessConditionStatus`.
332pub mod success_condition_status {
333    /// The type of condition being monitored.
334    #[derive(Clone, PartialEq, ::prost::Oneof)]
335    pub enum Condition {
336        #[prost(message, tag = "1")]
337        And(super::AndSuccessCondition),
338        #[prost(message, tag = "6")]
339        Timer(super::super::super::v1::TimerSuccessCondition),
340        /// ChannelValidationSuccessCondition channel_validation = 4;
341        /// OrSuccessConditionOrStatus or = 5;
342        #[prost(message, tag = "7")]
343        IngestJob(super::super::super::v1::IngestJobSuccessCondition),
344    }
345    /// The status of this condition.
346    #[derive(Clone, PartialEq, ::prost::Oneof)]
347    pub enum Status {
348        #[prost(message, tag = "2")]
349        InProgress(super::SuccessConditionInProgress),
350        #[prost(message, tag = "3")]
351        Satisfied(super::SuccessConditionSatisfied),
352        #[prost(message, tag = "4")]
353        Failed(super::SuccessConditionFailed),
354        #[prost(message, tag = "5")]
355        Canceled(super::SuccessConditionCanceled),
356        #[prost(message, tag = "8")]
357        Submitted(super::SuccessConditionSubmitted),
358    }
359}
360#[derive(Clone, PartialEq, ::prost::Message)]
361pub struct AndSuccessCondition {
362    #[prost(message, repeated, tag = "1")]
363    pub conditions: ::prost::alloc::vec::Vec<SuccessConditionStatus>,
364}
365#[derive(Clone, Copy, PartialEq, ::prost::Message)]
366pub struct SuccessConditionSubmitted {
367    #[prost(message, optional, tag = "1")]
368    pub submitted_at: ::core::option::Option<
369        super::super::super::super::google::protobuf::Timestamp,
370    >,
371}
372#[derive(Clone, Copy, PartialEq, ::prost::Message)]
373pub struct SuccessConditionInProgress {
374    #[prost(message, optional, tag = "1")]
375    pub started_at: ::core::option::Option<
376        super::super::super::super::google::protobuf::Timestamp,
377    >,
378}
379#[derive(Clone, Copy, PartialEq, ::prost::Message)]
380pub struct SuccessConditionSatisfied {
381    #[prost(message, optional, tag = "1")]
382    pub started_at: ::core::option::Option<
383        super::super::super::super::google::protobuf::Timestamp,
384    >,
385    #[prost(message, optional, tag = "2")]
386    pub satisfied_at: ::core::option::Option<
387        super::super::super::super::google::protobuf::Timestamp,
388    >,
389}
390#[derive(Clone, PartialEq, ::prost::Message)]
391pub struct SuccessConditionFailed {
392    #[prost(message, optional, tag = "1")]
393    pub started_at: ::core::option::Option<
394        super::super::super::super::google::protobuf::Timestamp,
395    >,
396    #[prost(message, optional, tag = "2")]
397    pub failed_at: ::core::option::Option<
398        super::super::super::super::google::protobuf::Timestamp,
399    >,
400    #[prost(string, tag = "3")]
401    pub failure_reason: ::prost::alloc::string::String,
402}
403#[derive(Clone, Copy, PartialEq, ::prost::Message)]
404pub struct SuccessConditionCanceled {
405    #[prost(message, optional, tag = "1")]
406    pub started_at: ::core::option::Option<
407        super::super::super::super::google::protobuf::Timestamp,
408    >,
409    #[prost(message, optional, tag = "2")]
410    pub canceled_at: ::core::option::Option<
411        super::super::super::super::google::protobuf::Timestamp,
412    >,
413}
414/// The status of a completion action and its result (if any).
415#[derive(Clone, PartialEq, ::prost::Message)]
416pub struct CompletionActionStatus {
417    #[prost(message, optional, tag = "1")]
418    pub state: ::core::option::Option<CompletionActionState>,
419    /// This is intentionally not a required oneof
420    #[prost(oneof = "completion_action_status::Result", tags = "2, 3, 4, 5")]
421    pub result: ::core::option::Option<completion_action_status::Result>,
422}
423/// Nested message and enum types in `CompletionActionStatus`.
424pub mod completion_action_status {
425    /// This is intentionally not a required oneof
426    #[derive(Clone, PartialEq, ::prost::Oneof)]
427    pub enum Result {
428        #[prost(message, tag = "2")]
429        CreateEvent(super::CreateEventResult),
430        #[prost(message, tag = "3")]
431        CreateRun(super::CreateRunResult),
432        #[prost(message, tag = "4")]
433        ApplyWorkbookTemplates(super::ApplyWorkbookTemplatesResult),
434        /// ...
435        #[prost(message, tag = "5")]
436        ApplyChecklists(super::ApplyChecklistsResult),
437    }
438}
439/// A CreateEvent action results in an EventRid if successful.
440#[derive(Clone, PartialEq, ::prost::Message)]
441pub struct CreateEventResult {
442    #[prost(string, tag = "1")]
443    pub event_rid: ::prost::alloc::string::String,
444}
445/// A CreateRun action results in a RunRid if successful.
446#[derive(Clone, PartialEq, ::prost::Message)]
447pub struct CreateRunResult {
448    #[prost(string, tag = "1")]
449    pub run_rid: ::prost::alloc::string::String,
450}
451/// An ApplyWorkbookTemplates action results in a list of workbook RIDs if successful.
452#[derive(Clone, PartialEq, ::prost::Message)]
453pub struct ApplyWorkbookTemplatesResult {
454    #[prost(string, repeated, tag = "1")]
455    pub workbook_rids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
456}
457/// An ApplyChecklists action results in a list of DataReviewRids if successful.
458#[derive(Clone, PartialEq, ::prost::Message)]
459pub struct ApplyChecklistsResult {
460    #[prost(string, repeated, tag = "1")]
461    pub data_review_rids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
462}
463#[derive(Clone, PartialEq, ::prost::Message)]
464pub struct CompletionActionState {
465    #[prost(oneof = "completion_action_state::State", tags = "1, 2, 3")]
466    pub state: ::core::option::Option<completion_action_state::State>,
467}
468/// Nested message and enum types in `CompletionActionState`.
469pub mod completion_action_state {
470    #[derive(Clone, Copy, PartialEq, ::prost::Message)]
471    pub struct NotRun {}
472    #[derive(Clone, Copy, PartialEq, ::prost::Message)]
473    pub struct Succeeded {}
474    #[derive(Clone, PartialEq, ::prost::Oneof)]
475    pub enum State {
476        /// The action was not run
477        #[prost(message, tag = "1")]
478        NotRun(NotRun),
479        /// The action was run and succeeded. The result is available in CompletionActionStatus.result
480        #[prost(message, tag = "2")]
481        Succeeded(Succeeded),
482        /// The action was run and errored. This field contains the error message.
483        #[prost(string, tag = "3")]
484        Error(::prost::alloc::string::String),
485    }
486}
487/// The value for a step's content. Should match the ProcedureStepNode type.
488#[derive(Clone, PartialEq, ::prost::Message)]
489pub struct StepContentValue {
490    #[prost(oneof = "step_content_value::Value", tags = "1, 2, 3")]
491    pub value: ::core::option::Option<step_content_value::Value>,
492}
493/// Nested message and enum types in `StepContentValue`.
494pub mod step_content_value {
495    #[derive(Clone, PartialEq, ::prost::Oneof)]
496    pub enum Value {
497        #[prost(message, tag = "1")]
498        Form(super::FormStepValue),
499        #[prost(message, tag = "2")]
500        StartIngest(super::StartIngestStepValue),
501        /// ...
502        #[prost(message, tag = "3")]
503        SelectOrCreateAsset(super::SelectOrCreateAssetStepValue),
504    }
505}
506#[derive(Clone, PartialEq, ::prost::Message)]
507pub struct FormStepValue {
508    #[prost(message, repeated, tag = "1")]
509    pub fields: ::prost::alloc::vec::Vec<FormFieldValue>,
510}
511#[derive(Clone, PartialEq, ::prost::Message)]
512pub struct StartIngestStepValue {
513    /// The RID of the ingest job that was started by the client.
514    /// This must be populated for the step to be submitted.
515    #[prost(string, optional, tag = "1")]
516    pub ingest_job_rid: ::core::option::Option<::prost::alloc::string::String>,
517}
518#[derive(Clone, PartialEq, ::prost::Message)]
519pub struct SelectOrCreateAssetStepValue {
520    /// The asset that was selected / created by the client.
521    /// This must be populated for the step to be submitted.
522    #[prost(message, optional, tag = "1")]
523    pub asset_reference: ::core::option::Option<super::super::v1::AssetReference>,
524}
525/// The value chosen for a form field.
526/// This differs from FieldOutput in that this should map 1:1 with FormField types,
527/// while FieldOutput contains the resolved values after the execution step is complete.
528#[derive(Clone, PartialEq, ::prost::Message)]
529pub struct FormFieldValue {
530    #[prost(oneof = "form_field_value::Field", tags = "1, 2, 3, 4, 5, 6, 7")]
531    pub field: ::core::option::Option<form_field_value::Field>,
532}
533/// Nested message and enum types in `FormFieldValue`.
534pub mod form_field_value {
535    #[derive(Clone, PartialEq, ::prost::Oneof)]
536    pub enum Field {
537        #[prost(message, tag = "1")]
538        Asset(super::AssetFieldValue),
539        #[prost(message, tag = "2")]
540        Checkbox(super::CheckboxFieldValue),
541        #[prost(message, tag = "3")]
542        Text(super::TextFieldValue),
543        #[prost(message, tag = "4")]
544        Int(super::IntFieldValue),
545        #[prost(message, tag = "5")]
546        Double(super::DoubleFieldValue),
547        #[prost(message, tag = "6")]
548        SingleEnum(super::SingleEnumFieldValue),
549        #[prost(message, tag = "7")]
550        MultiEnum(super::MultiEnumFieldValue),
551    }
552}
553#[derive(Clone, PartialEq, ::prost::Message)]
554pub struct AssetFieldValue {
555    /// This oneof will be unset if no asset is set on the field.
556    #[prost(oneof = "asset_field_value::Asset", tags = "1")]
557    pub asset: ::core::option::Option<asset_field_value::Asset>,
558}
559/// Nested message and enum types in `AssetFieldValue`.
560pub mod asset_field_value {
561    /// This oneof will be unset if no asset is set on the field.
562    #[derive(Clone, PartialEq, ::prost::Oneof)]
563    pub enum Asset {
564        #[prost(message, tag = "1")]
565        AssetReference(super::super::super::v1::AssetReference),
566    }
567}
568#[derive(Clone, Copy, PartialEq, ::prost::Message)]
569pub struct CheckboxFieldValue {
570    /// Default to false if not set
571    #[prost(bool, tag = "1")]
572    pub value: bool,
573}
574#[derive(Clone, PartialEq, ::prost::Message)]
575pub struct TextFieldValue {
576    /// Default to empty string if not set
577    #[prost(string, optional, tag = "1")]
578    pub value: ::core::option::Option<::prost::alloc::string::String>,
579}
580#[derive(Clone, Copy, PartialEq, ::prost::Message)]
581pub struct IntFieldValue {
582    #[prost(int64, optional, tag = "1")]
583    pub value: ::core::option::Option<i64>,
584}
585#[derive(Clone, Copy, PartialEq, ::prost::Message)]
586pub struct DoubleFieldValue {
587    #[prost(double, optional, tag = "1")]
588    pub value: ::core::option::Option<f64>,
589}
590#[derive(Clone, PartialEq, ::prost::Message)]
591pub struct SingleEnumFieldValue {
592    /// Default to empty string if not set
593    #[prost(string, optional, tag = "1")]
594    pub value: ::core::option::Option<::prost::alloc::string::String>,
595}
596#[derive(Clone, PartialEq, ::prost::Message)]
597pub struct MultiEnumFieldValue {
598    /// Default to empty list if not set
599    #[prost(string, repeated, tag = "1")]
600    pub value: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
601}
602#[derive(Clone, PartialEq, ::prost::Message)]
603pub struct ProcedureExecution {
604    #[prost(string, tag = "1")]
605    pub rid: ::prost::alloc::string::String,
606    #[prost(message, optional, tag = "2")]
607    pub metadata: ::core::option::Option<ProcedureExecutionMetadata>,
608    #[prost(message, optional, tag = "3")]
609    pub state: ::core::option::Option<ProcedureExecutionState>,
610}
611#[derive(Clone, PartialEq, ::prost::Message)]
612pub struct ProcedureExecutionMetadata {
613    #[prost(string, tag = "1")]
614    pub rid: ::prost::alloc::string::String,
615    /// The procedure template rid this execution is based on.
616    #[prost(string, tag = "2")]
617    pub procedure_rid: ::prost::alloc::string::String,
618    /// The commit ID of the procedure template this execution is based on.
619    /// This can be overridden at the node level for individual nodes.
620    #[prost(string, tag = "3")]
621    pub procedure_commit_id: ::prost::alloc::string::String,
622    #[prost(string, tag = "4")]
623    pub title: ::prost::alloc::string::String,
624    #[prost(string, optional, tag = "5")]
625    pub description: ::core::option::Option<::prost::alloc::string::String>,
626    #[prost(string, repeated, tag = "6")]
627    pub labels: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
628    #[prost(map = "string, string", tag = "7")]
629    pub properties: ::std::collections::HashMap<
630        ::prost::alloc::string::String,
631        ::prost::alloc::string::String,
632    >,
633    #[prost(string, tag = "8")]
634    pub created_by: ::prost::alloc::string::String,
635    #[prost(message, optional, tag = "9")]
636    pub created_at: ::core::option::Option<
637        super::super::super::super::google::protobuf::Timestamp,
638    >,
639    #[prost(string, tag = "10")]
640    pub updated_by: ::prost::alloc::string::String,
641    #[prost(message, optional, tag = "11")]
642    pub updated_at: ::core::option::Option<
643        super::super::super::super::google::protobuf::Timestamp,
644    >,
645    /// Will be unset until the execution transitions from NOT_STARTED to IN_PROGRESS.
646    #[prost(message, optional, tag = "12")]
647    pub started_at: ::core::option::Option<
648        super::super::super::super::google::protobuf::Timestamp,
649    >,
650    #[prost(string, optional, tag = "13")]
651    pub started_by: ::core::option::Option<::prost::alloc::string::String>,
652    /// Will be unset until the execution transitions from IN_PROGRESS to a terminal state.
653    #[prost(message, optional, tag = "14")]
654    pub finished_at: ::core::option::Option<
655        super::super::super::super::google::protobuf::Timestamp,
656    >,
657    #[prost(string, optional, tag = "15")]
658    pub finished_by: ::core::option::Option<::prost::alloc::string::String>,
659    /// Will be true/set if the execution is the ABORTED terminal state.
660    #[prost(message, optional, tag = "16")]
661    pub aborted_at: ::core::option::Option<
662        super::super::super::super::google::protobuf::Timestamp,
663    >,
664    #[prost(string, optional, tag = "17")]
665    pub aborted_by: ::core::option::Option<::prost::alloc::string::String>,
666    /// Will be set if the execution is in the ERRORED terminal state.
667    #[prost(message, optional, tag = "18")]
668    pub failed_at: ::core::option::Option<
669        super::super::super::super::google::protobuf::Timestamp,
670    >,
671    #[prost(string, optional, tag = "19")]
672    pub failed_by: ::core::option::Option<::prost::alloc::string::String>,
673    #[prost(string, optional, tag = "20")]
674    pub failed_reason: ::core::option::Option<::prost::alloc::string::String>,
675}
676/// ProcedureExecutionState is the state of an executing procedure.
677#[derive(Clone, PartialEq, ::prost::Message)]
678pub struct ProcedureExecutionState {
679    /// The current values for the global fields in the procedure.
680    #[prost(map = "string, message", tag = "1")]
681    pub global_fields: ::std::collections::HashMap<
682        ::prost::alloc::string::String,
683        FieldOutput,
684    >,
685    /// A map from execution node ID to the execution node.
686    #[prost(map = "string, message", tag = "2")]
687    pub nodes: ::std::collections::HashMap<
688        ::prost::alloc::string::String,
689        ProcedureExecutionNode,
690    >,
691    /// Section edges represent the visual grouping of sections and steps.
692    /// All keys are IDs for section nodes, and all values are lists of IDs for section or step nodes.
693    /// { A, \[B, C\] } means that section A visually groups nodes B and C together.
694    #[prost(map = "string, message", tag = "3")]
695    pub section_edges: ::std::collections::HashMap<
696        ::prost::alloc::string::String,
697        super::super::v1::NodeList,
698    >,
699    /// Step edges represent the dependencies between steps.
700    /// All keys and values are IDs for step nodes.
701    /// { A, \[B, C\] } means that steps B and C depend on step A to complete to be started
702    #[prost(map = "string, message", tag = "4")]
703    pub step_edges: ::std::collections::HashMap<
704        ::prost::alloc::string::String,
705        super::super::v1::NodeList,
706    >,
707}
708#[derive(Clone, PartialEq, ::prost::Message)]
709pub struct Strings {
710    #[prost(string, repeated, tag = "1")]
711    pub values: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
712}
713/// TODO(pchen): how to handle the value typing here
714/// The outputs of a field in a step.
715/// This is different from FormFieldValue in that this represents the resolved value after the step has
716/// been completed. Eg, this would contain an AssetRid while the FormFieldValue could contain an AssetReference
717#[derive(Clone, PartialEq, ::prost::Message)]
718pub struct FieldOutput {
719    /// The oneof can be unset if the field has not been set yet.
720    #[prost(oneof = "field_output::Output", tags = "1, 2, 3, 4, 5, 6, 7, 8")]
721    pub output: ::core::option::Option<field_output::Output>,
722}
723/// Nested message and enum types in `FieldOutput`.
724pub mod field_output {
725    /// The oneof can be unset if the field has not been set yet.
726    #[derive(Clone, PartialEq, ::prost::Oneof)]
727    pub enum Output {
728        /// TODO(niwong): I think this could actually be buf validated to be required. If a global field is
729        /// not yet defined, I think it's just not present in the global_fields map
730        /// option (buf.validate.oneof) = {required: true};
731        #[prost(string, tag = "1")]
732        AssetRid(::prost::alloc::string::String),
733        #[prost(string, tag = "2")]
734        StringValue(::prost::alloc::string::String),
735        #[prost(double, tag = "3")]
736        DoubleValue(f64),
737        #[prost(bool, tag = "4")]
738        BooleanValue(bool),
739        #[prost(int64, tag = "5")]
740        IntValue(i64),
741        #[prost(message, tag = "6")]
742        StringsValue(super::Strings),
743        #[prost(string, tag = "7")]
744        IngestJobRid(::prost::alloc::string::String),
745        #[prost(string, tag = "8")]
746        RunRid(::prost::alloc::string::String),
747    }
748}
749#[derive(Clone, PartialEq, ::prost::Message)]
750pub struct CreateProcedureExecutionRequest {
751    #[prost(string, tag = "1")]
752    pub procedure_rid: ::prost::alloc::string::String,
753    #[prost(string, tag = "2")]
754    pub procedure_commit_id: ::prost::alloc::string::String,
755    #[prost(string, tag = "3")]
756    pub title: ::prost::alloc::string::String,
757    #[prost(string, optional, tag = "4")]
758    pub description: ::core::option::Option<::prost::alloc::string::String>,
759}
760#[derive(Clone, PartialEq, ::prost::Message)]
761pub struct CreateProcedureExecutionResponse {
762    #[prost(message, optional, tag = "1")]
763    pub procedure_execution: ::core::option::Option<ProcedureExecution>,
764}
765#[derive(Clone, PartialEq, ::prost::Message)]
766pub struct GetProcedureExecutionRequest {
767    #[prost(string, tag = "1")]
768    pub procedure_execution_rid: ::prost::alloc::string::String,
769    /// If true, the display graph will be included in the response.
770    /// Default is false.
771    #[prost(bool, tag = "2")]
772    pub include_display_graph: bool,
773}
774#[derive(Clone, PartialEq, ::prost::Message)]
775pub struct GetProcedureExecutionResponse {
776    #[prost(message, optional, tag = "1")]
777    pub procedure_execution: ::core::option::Option<ProcedureExecution>,
778    /// Included if include_display_graph was set to true. Note that this is the
779    /// procedure template's display graph, not the execution graph.
780    #[prost(message, optional, tag = "2")]
781    pub display_graph: ::core::option::Option<super::super::v1::ProcedureDisplayGraph>,
782}
783#[derive(Clone, PartialEq, ::prost::Message)]
784pub struct UpdateProcedureExecutionMetadataRequest {
785    #[prost(string, tag = "1")]
786    pub procedure_execution_rid: ::prost::alloc::string::String,
787    #[prost(string, optional, tag = "2")]
788    pub title: ::core::option::Option<::prost::alloc::string::String>,
789    #[prost(string, optional, tag = "3")]
790    pub description: ::core::option::Option<::prost::alloc::string::String>,
791    #[prost(string, optional, tag = "4")]
792    pub commit_id: ::core::option::Option<::prost::alloc::string::String>,
793    #[prost(message, optional, tag = "5")]
794    pub labels: ::core::option::Option<super::super::super::types::LabelUpdateWrapper>,
795    #[prost(message, optional, tag = "6")]
796    pub properties: ::core::option::Option<
797        super::super::super::types::PropertyUpdateWrapper,
798    >,
799}
800#[derive(Clone, PartialEq, ::prost::Message)]
801pub struct UpdateProcedureExecutionMetadataResponse {
802    #[prost(message, optional, tag = "1")]
803    pub metadata: ::core::option::Option<ProcedureExecutionMetadata>,
804}
805/// TODO(niwong to pchen): I made an "update metadata" endpoint separately above,
806/// I think it'd be nice to turn this into a dedicated endpoint for changing the state of
807/// the overall execution (start, succeed, abort, fail)
808/// I also think in general we shouldn't be updating the entire ProcedureExecutionState
809/// but rather leveraging updateStep.
810/// TODO(WB-1879): allow to just update the global fields within the ProcExecState.
811#[derive(Clone, PartialEq, ::prost::Message)]
812pub struct UpdateProcedureExecutionRequest {
813    #[prost(string, tag = "1")]
814    pub procedure_execution_rid: ::prost::alloc::string::String,
815    #[prost(string, optional, tag = "2")]
816    pub title: ::core::option::Option<::prost::alloc::string::String>,
817    #[prost(string, optional, tag = "3")]
818    pub description: ::core::option::Option<::prost::alloc::string::String>,
819    #[prost(string, optional, tag = "4")]
820    pub commit_id: ::core::option::Option<::prost::alloc::string::String>,
821    #[prost(message, optional, tag = "5")]
822    pub labels: ::core::option::Option<super::super::super::types::LabelUpdateWrapper>,
823    #[prost(message, optional, tag = "6")]
824    pub properties: ::core::option::Option<
825        super::super::super::types::PropertyUpdateWrapper,
826    >,
827    #[prost(message, optional, tag = "7")]
828    pub state: ::core::option::Option<ProcedureExecutionState>,
829    #[prost(bool, optional, tag = "8")]
830    pub is_aborted: ::core::option::Option<bool>,
831    #[prost(message, optional, tag = "9")]
832    pub started_at: ::core::option::Option<
833        super::super::super::super::google::protobuf::Timestamp,
834    >,
835    #[prost(message, optional, tag = "10")]
836    pub finished_at: ::core::option::Option<
837        super::super::super::super::google::protobuf::Timestamp,
838    >,
839}
840#[derive(Clone, PartialEq, ::prost::Message)]
841pub struct UpdateProcedureExecutionResponse {
842    #[prost(message, optional, tag = "1")]
843    pub procedure_execution: ::core::option::Option<ProcedureExecution>,
844}
845#[derive(Clone, PartialEq, ::prost::Message)]
846pub struct UpdateStepRequest {
847    #[prost(string, tag = "1")]
848    pub procedure_execution_rid: ::prost::alloc::string::String,
849    /// The unique identifier of the execution step to update.
850    #[prost(string, tag = "2")]
851    pub step_id: ::prost::alloc::string::String,
852    /// Setting the value of the step's content. This is only allowed if the step is NOT_STARTED
853    /// or IN_PROGRESS.
854    #[prost(message, optional, tag = "3")]
855    pub value: ::core::option::Option<StepContentValue>,
856    /// Set whether the step has auto-proceed enabled. This is only allowed if the step is NOT_STARTED.
857    /// or IN_PROGRESS.
858    #[prost(message, optional, tag = "4")]
859    pub auto_proceed_config: ::core::option::Option<super::super::v1::AutoProceedConfig>,
860    /// Setting the state of the step. This will occur after the other updates in this request.
861    #[prost(message, optional, tag = "5")]
862    pub target_state: ::core::option::Option<TargetStepStateRequest>,
863}
864#[derive(Clone, PartialEq, ::prost::Message)]
865pub struct UpdateStepResponse {
866    #[prost(message, optional, tag = "1")]
867    pub procedure_execution: ::core::option::Option<ProcedureExecution>,
868}
869#[derive(Clone, PartialEq, ::prost::Message)]
870pub struct UpdateStepSuccessConditionStatusRequest {
871    #[prost(string, tag = "1")]
872    pub procedure_execution_rid: ::prost::alloc::string::String,
873    /// The unique identifier of the execution step to update.
874    #[prost(string, tag = "2")]
875    pub step_id: ::prost::alloc::string::String,
876    /// Setting the success_condition_status is only allowed if the step is SUBMITTED
877    /// and should only be done by the backend while monitoring the condition.
878    /// If the step is SKIPPED, the success_condition_status will still be set but
879    /// no completion actions will be run and the step's state will not be updated.
880    #[prost(message, optional, tag = "3")]
881    pub success_condition_status: ::core::option::Option<SuccessConditionStatus>,
882}
883#[derive(Clone, PartialEq, ::prost::Message)]
884pub struct UpdateStepSuccessConditionStatusResponse {
885    #[prost(message, optional, tag = "1")]
886    pub procedure_execution: ::core::option::Option<ProcedureExecution>,
887}
888#[derive(Clone, PartialEq, ::prost::Message)]
889pub struct ProcedureExecutionSearchQuery {
890    #[prost(
891        oneof = "procedure_execution_search_query::Query",
892        tags = "1, 2, 3, 4, 5, 6, 7, 8, 9"
893    )]
894    pub query: ::core::option::Option<procedure_execution_search_query::Query>,
895}
896/// Nested message and enum types in `ProcedureExecutionSearchQuery`.
897pub mod procedure_execution_search_query {
898    #[derive(Clone, PartialEq, ::prost::Message)]
899    pub struct ProcedureExecutionSearchAndQuery {
900        #[prost(message, repeated, tag = "1")]
901        pub queries: ::prost::alloc::vec::Vec<super::ProcedureExecutionSearchQuery>,
902    }
903    #[derive(Clone, PartialEq, ::prost::Message)]
904    pub struct ProcedureExecutionSearchOrQuery {
905        #[prost(message, repeated, tag = "1")]
906        pub queries: ::prost::alloc::vec::Vec<super::ProcedureExecutionSearchQuery>,
907    }
908    #[derive(Clone, PartialEq, ::prost::Oneof)]
909    pub enum Query {
910        #[prost(string, tag = "1")]
911        SearchText(::prost::alloc::string::String),
912        #[prost(string, tag = "2")]
913        Label(::prost::alloc::string::String),
914        #[prost(message, tag = "3")]
915        Property(super::super::super::super::types::Property),
916        #[prost(message, tag = "4")]
917        And(ProcedureExecutionSearchAndQuery),
918        #[prost(message, tag = "5")]
919        Or(ProcedureExecutionSearchOrQuery),
920        #[prost(string, tag = "6")]
921        Workspace(::prost::alloc::string::String),
922        #[prost(string, tag = "7")]
923        ProcedureRid(::prost::alloc::string::String),
924        #[prost(string, tag = "8")]
925        CommitId(::prost::alloc::string::String),
926        #[prost(string, tag = "9")]
927        CreatedBy(::prost::alloc::string::String),
928    }
929}
930#[derive(Clone, Copy, PartialEq, ::prost::Message)]
931pub struct ProcedureExecutionSortOptions {
932    #[prost(bool, tag = "1")]
933    pub is_descending: bool,
934    #[prost(enumeration = "SearchProcedureExecutionsSortField", tag = "2")]
935    pub sort_field: i32,
936}
937#[derive(Clone, PartialEq, ::prost::Message)]
938pub struct SearchProcedureExecutionsRequest {
939    #[prost(message, optional, tag = "1")]
940    pub query: ::core::option::Option<ProcedureExecutionSearchQuery>,
941    #[prost(message, optional, tag = "2")]
942    pub sort_options: ::core::option::Option<ProcedureExecutionSortOptions>,
943    /// Page sizes greater than 1_000 will be rejected. Default pageSize is 100.
944    #[prost(int32, optional, tag = "3")]
945    pub page_size: ::core::option::Option<i32>,
946    #[prost(string, optional, tag = "4")]
947    pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
948}
949#[derive(Clone, PartialEq, ::prost::Message)]
950pub struct SearchProcedureExecutionsResponse {
951    #[prost(message, repeated, tag = "1")]
952    pub procedure_executions: ::prost::alloc::vec::Vec<ProcedureExecutionMetadata>,
953    #[prost(string, optional, tag = "2")]
954    pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
955}
956#[derive(Clone, PartialEq, ::prost::Message)]
957pub struct BatchGetProcedureExecutionMetadataRequest {
958    #[prost(string, repeated, tag = "1")]
959    pub procedure_execution_rids: ::prost::alloc::vec::Vec<
960        ::prost::alloc::string::String,
961    >,
962}
963#[derive(Clone, PartialEq, ::prost::Message)]
964pub struct BatchGetProcedureExecutionMetadataResponse {
965    #[prost(message, repeated, tag = "1")]
966    pub procedure_executions: ::prost::alloc::vec::Vec<ProcedureExecutionMetadata>,
967}
968#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
969#[repr(i32)]
970pub enum SearchProcedureExecutionsSortField {
971    Unspecified = 0,
972    CreatedAt = 1,
973    StartedAt = 2,
974    FinishedAt = 3,
975    UpdatedAt = 4,
976}
977impl SearchProcedureExecutionsSortField {
978    /// String value of the enum field names used in the ProtoBuf definition.
979    ///
980    /// The values are not transformed in any way and thus are considered stable
981    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
982    pub fn as_str_name(&self) -> &'static str {
983        match self {
984            Self::Unspecified => "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UNSPECIFIED",
985            Self::CreatedAt => "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_CREATED_AT",
986            Self::StartedAt => "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_STARTED_AT",
987            Self::FinishedAt => "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_FINISHED_AT",
988            Self::UpdatedAt => "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UPDATED_AT",
989        }
990    }
991    /// Creates an enum from field names used in the ProtoBuf definition.
992    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
993        match value {
994            "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UNSPECIFIED" => {
995                Some(Self::Unspecified)
996            }
997            "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_CREATED_AT" => Some(Self::CreatedAt),
998            "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_STARTED_AT" => Some(Self::StartedAt),
999            "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_FINISHED_AT" => {
1000                Some(Self::FinishedAt)
1001            }
1002            "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UPDATED_AT" => Some(Self::UpdatedAt),
1003            _ => None,
1004        }
1005    }
1006}
1007#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
1008#[repr(i32)]
1009pub enum ProcedureExecutionsServiceError {
1010    Unspecified = 0,
1011    NotFound = 1,
1012    ProcNotFound = 2,
1013    NodeNotFound = 3,
1014    InvalidNode = 4,
1015    InvalidGraph = 5,
1016    InvalidStepTransition = 6,
1017    InvalidSearchToken = 7,
1018    InvalidStepUpdate = 8,
1019}
1020impl ProcedureExecutionsServiceError {
1021    /// String value of the enum field names used in the ProtoBuf definition.
1022    ///
1023    /// The values are not transformed in any way and thus are considered stable
1024    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
1025    pub fn as_str_name(&self) -> &'static str {
1026        match self {
1027            Self::Unspecified => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_UNSPECIFIED",
1028            Self::NotFound => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_NOT_FOUND",
1029            Self::ProcNotFound => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_PROC_NOT_FOUND",
1030            Self::NodeNotFound => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_NODE_NOT_FOUND",
1031            Self::InvalidNode => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_NODE",
1032            Self::InvalidGraph => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_GRAPH",
1033            Self::InvalidStepTransition => {
1034                "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_STEP_TRANSITION"
1035            }
1036            Self::InvalidSearchToken => {
1037                "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_SEARCH_TOKEN"
1038            }
1039            Self::InvalidStepUpdate => {
1040                "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_STEP_UPDATE"
1041            }
1042        }
1043    }
1044    /// Creates an enum from field names used in the ProtoBuf definition.
1045    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
1046        match value {
1047            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_UNSPECIFIED" => Some(Self::Unspecified),
1048            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_NOT_FOUND" => Some(Self::NotFound),
1049            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_PROC_NOT_FOUND" => {
1050                Some(Self::ProcNotFound)
1051            }
1052            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_NODE_NOT_FOUND" => {
1053                Some(Self::NodeNotFound)
1054            }
1055            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_NODE" => Some(Self::InvalidNode),
1056            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_GRAPH" => {
1057                Some(Self::InvalidGraph)
1058            }
1059            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_STEP_TRANSITION" => {
1060                Some(Self::InvalidStepTransition)
1061            }
1062            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_SEARCH_TOKEN" => {
1063                Some(Self::InvalidSearchToken)
1064            }
1065            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_STEP_UPDATE" => {
1066                Some(Self::InvalidStepUpdate)
1067            }
1068            _ => None,
1069        }
1070    }
1071}
1072/// Generated client implementations.
1073pub mod procedure_executions_service_client {
1074    #![allow(
1075        unused_variables,
1076        dead_code,
1077        missing_docs,
1078        clippy::wildcard_imports,
1079        clippy::let_unit_value,
1080    )]
1081    use tonic::codegen::*;
1082    use tonic::codegen::http::Uri;
1083    /// Service for creating and managing procedure executions.
1084    #[derive(Debug, Clone)]
1085    pub struct ProcedureExecutionsServiceClient<T> {
1086        inner: tonic::client::Grpc<T>,
1087    }
1088    impl ProcedureExecutionsServiceClient<tonic::transport::Channel> {
1089        /// Attempt to create a new client by connecting to a given endpoint.
1090        pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
1091        where
1092            D: TryInto<tonic::transport::Endpoint>,
1093            D::Error: Into<StdError>,
1094        {
1095            let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
1096            Ok(Self::new(conn))
1097        }
1098    }
1099    impl<T> ProcedureExecutionsServiceClient<T>
1100    where
1101        T: tonic::client::GrpcService<tonic::body::Body>,
1102        T::Error: Into<StdError>,
1103        T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
1104        <T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
1105    {
1106        pub fn new(inner: T) -> Self {
1107            let inner = tonic::client::Grpc::new(inner);
1108            Self { inner }
1109        }
1110        pub fn with_origin(inner: T, origin: Uri) -> Self {
1111            let inner = tonic::client::Grpc::with_origin(inner, origin);
1112            Self { inner }
1113        }
1114        pub fn with_interceptor<F>(
1115            inner: T,
1116            interceptor: F,
1117        ) -> ProcedureExecutionsServiceClient<InterceptedService<T, F>>
1118        where
1119            F: tonic::service::Interceptor,
1120            T::ResponseBody: Default,
1121            T: tonic::codegen::Service<
1122                http::Request<tonic::body::Body>,
1123                Response = http::Response<
1124                    <T as tonic::client::GrpcService<tonic::body::Body>>::ResponseBody,
1125                >,
1126            >,
1127            <T as tonic::codegen::Service<
1128                http::Request<tonic::body::Body>,
1129            >>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
1130        {
1131            ProcedureExecutionsServiceClient::new(
1132                InterceptedService::new(inner, interceptor),
1133            )
1134        }
1135        /// Compress requests with the given encoding.
1136        ///
1137        /// This requires the server to support it otherwise it might respond with an
1138        /// error.
1139        #[must_use]
1140        pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
1141            self.inner = self.inner.send_compressed(encoding);
1142            self
1143        }
1144        /// Enable decompressing responses.
1145        #[must_use]
1146        pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
1147            self.inner = self.inner.accept_compressed(encoding);
1148            self
1149        }
1150        /// Limits the maximum size of a decoded message.
1151        ///
1152        /// Default: `4MB`
1153        #[must_use]
1154        pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
1155            self.inner = self.inner.max_decoding_message_size(limit);
1156            self
1157        }
1158        /// Limits the maximum size of an encoded message.
1159        ///
1160        /// Default: `usize::MAX`
1161        #[must_use]
1162        pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
1163            self.inner = self.inner.max_encoding_message_size(limit);
1164            self
1165        }
1166        /// Create a new procedure execution from a procedure
1167        pub async fn create_procedure_execution(
1168            &mut self,
1169            request: impl tonic::IntoRequest<super::CreateProcedureExecutionRequest>,
1170        ) -> std::result::Result<
1171            tonic::Response<super::CreateProcedureExecutionResponse>,
1172            tonic::Status,
1173        > {
1174            self.inner
1175                .ready()
1176                .await
1177                .map_err(|e| {
1178                    tonic::Status::unknown(
1179                        format!("Service was not ready: {}", e.into()),
1180                    )
1181                })?;
1182            let codec = tonic::codec::ProstCodec::default();
1183            let path = http::uri::PathAndQuery::from_static(
1184                "/nominal.procedures.executions.v1.ProcedureExecutionsService/CreateProcedureExecution",
1185            );
1186            let mut req = request.into_request();
1187            req.extensions_mut()
1188                .insert(
1189                    GrpcMethod::new(
1190                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1191                        "CreateProcedureExecution",
1192                    ),
1193                );
1194            self.inner.unary(req, path, codec).await
1195        }
1196        /// Get a procedure execution by its RID
1197        pub async fn get_procedure_execution(
1198            &mut self,
1199            request: impl tonic::IntoRequest<super::GetProcedureExecutionRequest>,
1200        ) -> std::result::Result<
1201            tonic::Response<super::GetProcedureExecutionResponse>,
1202            tonic::Status,
1203        > {
1204            self.inner
1205                .ready()
1206                .await
1207                .map_err(|e| {
1208                    tonic::Status::unknown(
1209                        format!("Service was not ready: {}", e.into()),
1210                    )
1211                })?;
1212            let codec = tonic::codec::ProstCodec::default();
1213            let path = http::uri::PathAndQuery::from_static(
1214                "/nominal.procedures.executions.v1.ProcedureExecutionsService/GetProcedureExecution",
1215            );
1216            let mut req = request.into_request();
1217            req.extensions_mut()
1218                .insert(
1219                    GrpcMethod::new(
1220                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1221                        "GetProcedureExecution",
1222                    ),
1223                );
1224            self.inner.unary(req, path, codec).await
1225        }
1226        /// Update the metadata of a procedure execution
1227        pub async fn update_procedure_execution_metadata(
1228            &mut self,
1229            request: impl tonic::IntoRequest<
1230                super::UpdateProcedureExecutionMetadataRequest,
1231            >,
1232        ) -> std::result::Result<
1233            tonic::Response<super::UpdateProcedureExecutionMetadataResponse>,
1234            tonic::Status,
1235        > {
1236            self.inner
1237                .ready()
1238                .await
1239                .map_err(|e| {
1240                    tonic::Status::unknown(
1241                        format!("Service was not ready: {}", e.into()),
1242                    )
1243                })?;
1244            let codec = tonic::codec::ProstCodec::default();
1245            let path = http::uri::PathAndQuery::from_static(
1246                "/nominal.procedures.executions.v1.ProcedureExecutionsService/UpdateProcedureExecutionMetadata",
1247            );
1248            let mut req = request.into_request();
1249            req.extensions_mut()
1250                .insert(
1251                    GrpcMethod::new(
1252                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1253                        "UpdateProcedureExecutionMetadata",
1254                    ),
1255                );
1256            self.inner.unary(req, path, codec).await
1257        }
1258        /// Heavy-handed update method for procedure execution
1259        /// TODO(pchen): This isn't the expected final endpoint, this is just for editing the graph while we iterate
1260        /// There likely be additional fine-grained methods for editing the procedure
1261        pub async fn update_procedure_execution(
1262            &mut self,
1263            request: impl tonic::IntoRequest<super::UpdateProcedureExecutionRequest>,
1264        ) -> std::result::Result<
1265            tonic::Response<super::UpdateProcedureExecutionResponse>,
1266            tonic::Status,
1267        > {
1268            self.inner
1269                .ready()
1270                .await
1271                .map_err(|e| {
1272                    tonic::Status::unknown(
1273                        format!("Service was not ready: {}", e.into()),
1274                    )
1275                })?;
1276            let codec = tonic::codec::ProstCodec::default();
1277            let path = http::uri::PathAndQuery::from_static(
1278                "/nominal.procedures.executions.v1.ProcedureExecutionsService/UpdateProcedureExecution",
1279            );
1280            let mut req = request.into_request();
1281            req.extensions_mut()
1282                .insert(
1283                    GrpcMethod::new(
1284                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1285                        "UpdateProcedureExecution",
1286                    ),
1287                );
1288            self.inner.unary(req, path, codec).await
1289        }
1290        /// Update the status of a step in a procedure execution. This can only be done if the step is NOT_STARTED,
1291        /// IN_PROGRESS, or SUBMITTED. Other state transitions are managed by the backend.
1292        pub async fn update_step(
1293            &mut self,
1294            request: impl tonic::IntoRequest<super::UpdateStepRequest>,
1295        ) -> std::result::Result<
1296            tonic::Response<super::UpdateStepResponse>,
1297            tonic::Status,
1298        > {
1299            self.inner
1300                .ready()
1301                .await
1302                .map_err(|e| {
1303                    tonic::Status::unknown(
1304                        format!("Service was not ready: {}", e.into()),
1305                    )
1306                })?;
1307            let codec = tonic::codec::ProstCodec::default();
1308            let path = http::uri::PathAndQuery::from_static(
1309                "/nominal.procedures.executions.v1.ProcedureExecutionsService/UpdateStep",
1310            );
1311            let mut req = request.into_request();
1312            req.extensions_mut()
1313                .insert(
1314                    GrpcMethod::new(
1315                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1316                        "UpdateStep",
1317                    ),
1318                );
1319            self.inner.unary(req, path, codec).await
1320        }
1321        /// This should only be called by the backend to update the success_condition_status of a step.
1322        /// This can only be done if the step is SUBMITTED.
1323        pub async fn update_step_success_condition_status(
1324            &mut self,
1325            request: impl tonic::IntoRequest<
1326                super::UpdateStepSuccessConditionStatusRequest,
1327            >,
1328        ) -> std::result::Result<
1329            tonic::Response<super::UpdateStepSuccessConditionStatusResponse>,
1330            tonic::Status,
1331        > {
1332            self.inner
1333                .ready()
1334                .await
1335                .map_err(|e| {
1336                    tonic::Status::unknown(
1337                        format!("Service was not ready: {}", e.into()),
1338                    )
1339                })?;
1340            let codec = tonic::codec::ProstCodec::default();
1341            let path = http::uri::PathAndQuery::from_static(
1342                "/nominal.procedures.executions.v1.ProcedureExecutionsService/UpdateStepSuccessConditionStatus",
1343            );
1344            let mut req = request.into_request();
1345            req.extensions_mut()
1346                .insert(
1347                    GrpcMethod::new(
1348                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1349                        "UpdateStepSuccessConditionStatus",
1350                    ),
1351                );
1352            self.inner.unary(req, path, codec).await
1353        }
1354        /// Search for procedure executions
1355        pub async fn search_procedure_executions(
1356            &mut self,
1357            request: impl tonic::IntoRequest<super::SearchProcedureExecutionsRequest>,
1358        ) -> std::result::Result<
1359            tonic::Response<super::SearchProcedureExecutionsResponse>,
1360            tonic::Status,
1361        > {
1362            self.inner
1363                .ready()
1364                .await
1365                .map_err(|e| {
1366                    tonic::Status::unknown(
1367                        format!("Service was not ready: {}", e.into()),
1368                    )
1369                })?;
1370            let codec = tonic::codec::ProstCodec::default();
1371            let path = http::uri::PathAndQuery::from_static(
1372                "/nominal.procedures.executions.v1.ProcedureExecutionsService/SearchProcedureExecutions",
1373            );
1374            let mut req = request.into_request();
1375            req.extensions_mut()
1376                .insert(
1377                    GrpcMethod::new(
1378                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1379                        "SearchProcedureExecutions",
1380                    ),
1381                );
1382            self.inner.unary(req, path, codec).await
1383        }
1384        /// Batch get procedure execution metadata
1385        pub async fn batch_get_procedure_execution_metadata(
1386            &mut self,
1387            request: impl tonic::IntoRequest<
1388                super::BatchGetProcedureExecutionMetadataRequest,
1389            >,
1390        ) -> std::result::Result<
1391            tonic::Response<super::BatchGetProcedureExecutionMetadataResponse>,
1392            tonic::Status,
1393        > {
1394            self.inner
1395                .ready()
1396                .await
1397                .map_err(|e| {
1398                    tonic::Status::unknown(
1399                        format!("Service was not ready: {}", e.into()),
1400                    )
1401                })?;
1402            let codec = tonic::codec::ProstCodec::default();
1403            let path = http::uri::PathAndQuery::from_static(
1404                "/nominal.procedures.executions.v1.ProcedureExecutionsService/BatchGetProcedureExecutionMetadata",
1405            );
1406            let mut req = request.into_request();
1407            req.extensions_mut()
1408                .insert(
1409                    GrpcMethod::new(
1410                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1411                        "BatchGetProcedureExecutionMetadata",
1412                    ),
1413                );
1414            self.inner.unary(req, path, codec).await
1415        }
1416    }
1417}
nominal_api/proto/nominal.procedures.executions.v1.rs

nominal_api/proto/
nominal.procedures.executions.v1.rs
