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, 8, 9")]
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        #[prost(message, tag = "8")]
552        FileUpload(super::FileUploadFieldValue),
553        #[prost(message, tag = "9")]
554        MultiFileUpload(super::MultiFileUploadFieldValue),
555    }
556}
557#[derive(Clone, PartialEq, ::prost::Message)]
558pub struct AssetFieldValue {
559    /// This oneof will be unset if no asset is set on the field.
560    #[prost(oneof = "asset_field_value::Asset", tags = "1")]
561    pub asset: ::core::option::Option<asset_field_value::Asset>,
562}
563/// Nested message and enum types in `AssetFieldValue`.
564pub mod asset_field_value {
565    /// This oneof will be unset if no asset is set on the field.
566    #[derive(Clone, PartialEq, ::prost::Oneof)]
567    pub enum Asset {
568        #[prost(message, tag = "1")]
569        AssetReference(super::super::super::v1::AssetReference),
570    }
571}
572#[derive(Clone, Copy, PartialEq, ::prost::Message)]
573pub struct CheckboxFieldValue {
574    /// Default to false if not set
575    #[prost(bool, tag = "1")]
576    pub value: bool,
577}
578#[derive(Clone, PartialEq, ::prost::Message)]
579pub struct TextFieldValue {
580    /// Default to empty string if not set
581    #[prost(string, optional, tag = "1")]
582    pub value: ::core::option::Option<::prost::alloc::string::String>,
583}
584#[derive(Clone, Copy, PartialEq, ::prost::Message)]
585pub struct IntFieldValue {
586    #[prost(int64, optional, tag = "1")]
587    pub value: ::core::option::Option<i64>,
588}
589#[derive(Clone, Copy, PartialEq, ::prost::Message)]
590pub struct DoubleFieldValue {
591    #[prost(double, optional, tag = "1")]
592    pub value: ::core::option::Option<f64>,
593}
594#[derive(Clone, PartialEq, ::prost::Message)]
595pub struct SingleEnumFieldValue {
596    /// Default to empty string if not set
597    #[prost(string, optional, tag = "1")]
598    pub value: ::core::option::Option<::prost::alloc::string::String>,
599}
600#[derive(Clone, PartialEq, ::prost::Message)]
601pub struct MultiEnumFieldValue {
602    /// Default to empty list if not set
603    #[prost(string, repeated, tag = "1")]
604    pub value: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
605}
606/// Corresponds to usage of the upload api
607#[derive(Clone, PartialEq, ::prost::Message)]
608pub struct FileUploadFieldValue {
609    #[prost(oneof = "file_upload_field_value::UploadType", tags = "1")]
610    pub upload_type: ::core::option::Option<file_upload_field_value::UploadType>,
611}
612/// Nested message and enum types in `FileUploadFieldValue`.
613pub mod file_upload_field_value {
614    #[derive(Clone, PartialEq, ::prost::Oneof)]
615    pub enum UploadType {
616        #[prost(message, tag = "1")]
617        S3Upload(super::S3UploadFileValue),
618    }
619}
620#[derive(Clone, PartialEq, ::prost::Message)]
621pub struct S3UploadFileValue {
622    /// The S3 path where the uploaded file is stored
623    #[prost(string, tag = "1")]
624    pub s3_path: ::prost::alloc::string::String,
625    /// The original filename of the uploaded file
626    #[prost(string, tag = "2")]
627    pub file_name: ::prost::alloc::string::String,
628    /// The MIME type of the uploaded file
629    #[prost(string, tag = "3")]
630    pub file_type: ::prost::alloc::string::String,
631}
632#[derive(Clone, PartialEq, ::prost::Message)]
633pub struct MultiFileUploadFieldValue {
634    /// The list of uploads
635    #[prost(message, repeated, tag = "1")]
636    pub uploads: ::prost::alloc::vec::Vec<FileUploadFieldValue>,
637}
638#[derive(Clone, PartialEq, ::prost::Message)]
639pub struct ProcedureExecution {
640    #[prost(string, tag = "1")]
641    pub rid: ::prost::alloc::string::String,
642    #[prost(message, optional, tag = "2")]
643    pub metadata: ::core::option::Option<ProcedureExecutionMetadata>,
644    #[prost(message, optional, tag = "3")]
645    pub state: ::core::option::Option<ProcedureExecutionState>,
646}
647#[derive(Clone, PartialEq, ::prost::Message)]
648pub struct ProcedureExecutionMetadata {
649    #[prost(string, tag = "1")]
650    pub rid: ::prost::alloc::string::String,
651    /// The procedure template rid this execution is based on.
652    #[prost(string, tag = "2")]
653    pub procedure_rid: ::prost::alloc::string::String,
654    /// The commit ID of the procedure template this execution is based on.
655    /// This can be overridden at the node level for individual nodes.
656    #[prost(string, tag = "3")]
657    pub procedure_commit_id: ::prost::alloc::string::String,
658    #[prost(string, tag = "4")]
659    pub title: ::prost::alloc::string::String,
660    #[prost(string, optional, tag = "5")]
661    pub description: ::core::option::Option<::prost::alloc::string::String>,
662    #[prost(string, repeated, tag = "6")]
663    pub labels: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
664    #[prost(map = "string, string", tag = "7")]
665    pub properties: ::std::collections::HashMap<
666        ::prost::alloc::string::String,
667        ::prost::alloc::string::String,
668    >,
669    #[prost(string, tag = "8")]
670    pub created_by: ::prost::alloc::string::String,
671    #[prost(message, optional, tag = "9")]
672    pub created_at: ::core::option::Option<
673        super::super::super::super::google::protobuf::Timestamp,
674    >,
675    #[prost(string, tag = "10")]
676    pub updated_by: ::prost::alloc::string::String,
677    #[prost(message, optional, tag = "11")]
678    pub updated_at: ::core::option::Option<
679        super::super::super::super::google::protobuf::Timestamp,
680    >,
681    /// Will be unset until the execution transitions from NOT_STARTED to IN_PROGRESS.
682    #[prost(message, optional, tag = "12")]
683    pub started_at: ::core::option::Option<
684        super::super::super::super::google::protobuf::Timestamp,
685    >,
686    #[prost(string, optional, tag = "13")]
687    pub started_by: ::core::option::Option<::prost::alloc::string::String>,
688    /// Will be unset until the execution transitions from IN_PROGRESS to a terminal state.
689    #[prost(message, optional, tag = "14")]
690    pub finished_at: ::core::option::Option<
691        super::super::super::super::google::protobuf::Timestamp,
692    >,
693    #[prost(string, optional, tag = "15")]
694    pub finished_by: ::core::option::Option<::prost::alloc::string::String>,
695    /// Will be true/set if the execution is the ABORTED terminal state.
696    #[prost(message, optional, tag = "16")]
697    pub aborted_at: ::core::option::Option<
698        super::super::super::super::google::protobuf::Timestamp,
699    >,
700    #[prost(string, optional, tag = "17")]
701    pub aborted_by: ::core::option::Option<::prost::alloc::string::String>,
702    /// Will be set if the execution is in the ERRORED terminal state.
703    #[prost(message, optional, tag = "18")]
704    pub failed_at: ::core::option::Option<
705        super::super::super::super::google::protobuf::Timestamp,
706    >,
707    #[prost(string, optional, tag = "19")]
708    pub failed_by: ::core::option::Option<::prost::alloc::string::String>,
709    #[prost(string, optional, tag = "20")]
710    pub failed_reason: ::core::option::Option<::prost::alloc::string::String>,
711}
712/// ProcedureExecutionState is the state of an executing procedure.
713#[derive(Clone, PartialEq, ::prost::Message)]
714pub struct ProcedureExecutionState {
715    /// The current values for the global fields in the procedure.
716    #[prost(map = "string, message", tag = "1")]
717    pub global_fields: ::std::collections::HashMap<
718        ::prost::alloc::string::String,
719        FieldOutput,
720    >,
721    /// A map from execution node ID to the execution node.
722    #[prost(map = "string, message", tag = "2")]
723    pub nodes: ::std::collections::HashMap<
724        ::prost::alloc::string::String,
725        ProcedureExecutionNode,
726    >,
727    /// Section edges represent the visual grouping of sections and steps.
728    /// All keys are IDs for section nodes, and all values are lists of IDs for section or step nodes.
729    /// { A, \[B, C\] } means that section A visually groups nodes B and C together.
730    #[prost(map = "string, message", tag = "3")]
731    pub section_edges: ::std::collections::HashMap<
732        ::prost::alloc::string::String,
733        super::super::v1::NodeList,
734    >,
735    /// Step edges represent the dependencies between steps.
736    /// All keys and values are IDs for step nodes.
737    /// { A, \[B, C\] } means that steps B and C depend on step A to complete to be started
738    #[prost(map = "string, message", tag = "4")]
739    pub step_edges: ::std::collections::HashMap<
740        ::prost::alloc::string::String,
741        super::super::v1::NodeList,
742    >,
743}
744#[derive(Clone, PartialEq, ::prost::Message)]
745pub struct Strings {
746    #[prost(string, repeated, tag = "1")]
747    pub values: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
748}
749/// TODO(pchen): how to handle the value typing here
750/// The outputs of a field in a step.
751/// This is different from FormFieldValue in that this represents the resolved value after the step has
752/// been completed. Eg, this would contain an AssetRid while the FormFieldValue could contain an AssetReference
753#[derive(Clone, PartialEq, ::prost::Message)]
754pub struct FieldOutput {
755    /// The oneof can be unset if the field has not been set yet.
756    #[prost(oneof = "field_output::Output", tags = "1, 2, 3, 4, 5, 6, 7, 8, 9, 10")]
757    pub output: ::core::option::Option<field_output::Output>,
758}
759/// Nested message and enum types in `FieldOutput`.
760pub mod field_output {
761    /// The oneof can be unset if the field has not been set yet.
762    #[derive(Clone, PartialEq, ::prost::Oneof)]
763    pub enum Output {
764        /// TODO(niwong): I think this could actually be buf validated to be required. If a global field is
765        /// not yet defined, I think it's just not present in the global_fields map
766        /// option (buf.validate.oneof) = {required: true};
767        #[prost(string, tag = "1")]
768        AssetRid(::prost::alloc::string::String),
769        #[prost(string, tag = "2")]
770        StringValue(::prost::alloc::string::String),
771        #[prost(double, tag = "3")]
772        DoubleValue(f64),
773        #[prost(bool, tag = "4")]
774        BooleanValue(bool),
775        #[prost(int64, tag = "5")]
776        IntValue(i64),
777        #[prost(message, tag = "6")]
778        StringsValue(super::Strings),
779        #[prost(string, tag = "7")]
780        IngestJobRid(::prost::alloc::string::String),
781        #[prost(string, tag = "8")]
782        RunRid(::prost::alloc::string::String),
783        #[prost(message, tag = "9")]
784        FileUploadValue(super::FileUploadFieldValue),
785        #[prost(message, tag = "10")]
786        MultiFileUploadValue(super::MultiFileUploadFieldValue),
787    }
788}
789#[derive(Clone, PartialEq, ::prost::Message)]
790pub struct CreateProcedureExecutionRequest {
791    #[prost(string, tag = "1")]
792    pub procedure_rid: ::prost::alloc::string::String,
793    #[prost(string, tag = "2")]
794    pub procedure_commit_id: ::prost::alloc::string::String,
795    #[prost(string, tag = "3")]
796    pub title: ::prost::alloc::string::String,
797    #[prost(string, optional, tag = "4")]
798    pub description: ::core::option::Option<::prost::alloc::string::String>,
799}
800#[derive(Clone, PartialEq, ::prost::Message)]
801pub struct CreateProcedureExecutionResponse {
802    #[prost(message, optional, tag = "1")]
803    pub procedure_execution: ::core::option::Option<ProcedureExecution>,
804}
805#[derive(Clone, PartialEq, ::prost::Message)]
806pub struct GetProcedureExecutionRequest {
807    #[prost(string, tag = "1")]
808    pub procedure_execution_rid: ::prost::alloc::string::String,
809    /// If true, the display graph will be included in the response.
810    /// Default is false.
811    #[prost(bool, tag = "2")]
812    pub include_display_graph: bool,
813}
814#[derive(Clone, PartialEq, ::prost::Message)]
815pub struct GetProcedureExecutionResponse {
816    #[prost(message, optional, tag = "1")]
817    pub procedure_execution: ::core::option::Option<ProcedureExecution>,
818    /// Included if include_display_graph was set to true. Note that this is the
819    /// procedure template's display graph, not the execution graph.
820    #[prost(message, optional, tag = "2")]
821    pub display_graph: ::core::option::Option<super::super::v1::ProcedureDisplayGraph>,
822}
823#[derive(Clone, PartialEq, ::prost::Message)]
824pub struct UpdateProcedureExecutionMetadataRequest {
825    #[prost(string, tag = "1")]
826    pub procedure_execution_rid: ::prost::alloc::string::String,
827    #[prost(string, optional, tag = "2")]
828    pub title: ::core::option::Option<::prost::alloc::string::String>,
829    #[prost(string, optional, tag = "3")]
830    pub description: ::core::option::Option<::prost::alloc::string::String>,
831    #[prost(string, optional, tag = "4")]
832    pub commit_id: ::core::option::Option<::prost::alloc::string::String>,
833    #[prost(message, optional, tag = "5")]
834    pub labels: ::core::option::Option<super::super::super::types::LabelUpdateWrapper>,
835    #[prost(message, optional, tag = "6")]
836    pub properties: ::core::option::Option<
837        super::super::super::types::PropertyUpdateWrapper,
838    >,
839}
840#[derive(Clone, PartialEq, ::prost::Message)]
841pub struct UpdateProcedureExecutionMetadataResponse {
842    #[prost(message, optional, tag = "1")]
843    pub metadata: ::core::option::Option<ProcedureExecutionMetadata>,
844}
845/// TODO(niwong to pchen): I made an "update metadata" endpoint separately above,
846/// I think it'd be nice to turn this into a dedicated endpoint for changing the state of
847/// the overall execution (start, succeed, abort, fail)
848/// I also think in general we shouldn't be updating the entire ProcedureExecutionState
849/// but rather leveraging updateStep.
850/// TODO(WB-1879): allow to just update the global fields within the ProcExecState.
851#[derive(Clone, PartialEq, ::prost::Message)]
852pub struct UpdateProcedureExecutionRequest {
853    #[prost(string, tag = "1")]
854    pub procedure_execution_rid: ::prost::alloc::string::String,
855    #[prost(string, optional, tag = "2")]
856    pub title: ::core::option::Option<::prost::alloc::string::String>,
857    #[prost(string, optional, tag = "3")]
858    pub description: ::core::option::Option<::prost::alloc::string::String>,
859    #[prost(string, optional, tag = "4")]
860    pub commit_id: ::core::option::Option<::prost::alloc::string::String>,
861    #[prost(message, optional, tag = "5")]
862    pub labels: ::core::option::Option<super::super::super::types::LabelUpdateWrapper>,
863    #[prost(message, optional, tag = "6")]
864    pub properties: ::core::option::Option<
865        super::super::super::types::PropertyUpdateWrapper,
866    >,
867    #[prost(message, optional, tag = "7")]
868    pub state: ::core::option::Option<ProcedureExecutionState>,
869    #[prost(bool, optional, tag = "8")]
870    pub is_aborted: ::core::option::Option<bool>,
871    #[prost(message, optional, tag = "9")]
872    pub started_at: ::core::option::Option<
873        super::super::super::super::google::protobuf::Timestamp,
874    >,
875    #[prost(message, optional, tag = "10")]
876    pub finished_at: ::core::option::Option<
877        super::super::super::super::google::protobuf::Timestamp,
878    >,
879}
880#[derive(Clone, PartialEq, ::prost::Message)]
881pub struct UpdateProcedureExecutionResponse {
882    #[prost(message, optional, tag = "1")]
883    pub procedure_execution: ::core::option::Option<ProcedureExecution>,
884}
885#[derive(Clone, PartialEq, ::prost::Message)]
886pub struct UpdateStepRequest {
887    #[prost(string, tag = "1")]
888    pub procedure_execution_rid: ::prost::alloc::string::String,
889    /// The unique identifier of the execution step to update.
890    #[prost(string, tag = "2")]
891    pub step_id: ::prost::alloc::string::String,
892    /// Setting the value of the step's content. This is only allowed if the step is NOT_STARTED
893    /// or IN_PROGRESS.
894    #[prost(message, optional, tag = "3")]
895    pub value: ::core::option::Option<StepContentValue>,
896    /// Set whether the step has auto-proceed enabled. This is only allowed if the step is NOT_STARTED.
897    /// or IN_PROGRESS.
898    #[prost(message, optional, tag = "4")]
899    pub auto_proceed_config: ::core::option::Option<super::super::v1::AutoProceedConfig>,
900    /// Setting the state of the step. This will occur after the other updates in this request.
901    #[prost(message, optional, tag = "5")]
902    pub target_state: ::core::option::Option<TargetStepStateRequest>,
903}
904#[derive(Clone, PartialEq, ::prost::Message)]
905pub struct UpdateStepResponse {
906    #[prost(message, optional, tag = "1")]
907    pub procedure_execution: ::core::option::Option<ProcedureExecution>,
908}
909#[derive(Clone, PartialEq, ::prost::Message)]
910pub struct UpdateStepSuccessConditionStatusRequest {
911    #[prost(string, tag = "1")]
912    pub procedure_execution_rid: ::prost::alloc::string::String,
913    /// The unique identifier of the execution step to update.
914    #[prost(string, tag = "2")]
915    pub step_id: ::prost::alloc::string::String,
916    /// Setting the success_condition_status is only allowed if the step is SUBMITTED
917    /// and should only be done by the backend while monitoring the condition.
918    /// If the step is SKIPPED, the success_condition_status will still be set but
919    /// no completion actions will be run and the step's state will not be updated.
920    #[prost(message, optional, tag = "3")]
921    pub success_condition_status: ::core::option::Option<SuccessConditionStatus>,
922}
923#[derive(Clone, PartialEq, ::prost::Message)]
924pub struct UpdateStepSuccessConditionStatusResponse {
925    #[prost(message, optional, tag = "1")]
926    pub procedure_execution: ::core::option::Option<ProcedureExecution>,
927}
928#[derive(Clone, PartialEq, ::prost::Message)]
929pub struct ProcedureExecutionSearchQuery {
930    #[prost(
931        oneof = "procedure_execution_search_query::Query",
932        tags = "1, 2, 3, 4, 5, 6, 7, 8, 9"
933    )]
934    pub query: ::core::option::Option<procedure_execution_search_query::Query>,
935}
936/// Nested message and enum types in `ProcedureExecutionSearchQuery`.
937pub mod procedure_execution_search_query {
938    #[derive(Clone, PartialEq, ::prost::Message)]
939    pub struct ProcedureExecutionSearchAndQuery {
940        #[prost(message, repeated, tag = "1")]
941        pub queries: ::prost::alloc::vec::Vec<super::ProcedureExecutionSearchQuery>,
942    }
943    #[derive(Clone, PartialEq, ::prost::Message)]
944    pub struct ProcedureExecutionSearchOrQuery {
945        #[prost(message, repeated, tag = "1")]
946        pub queries: ::prost::alloc::vec::Vec<super::ProcedureExecutionSearchQuery>,
947    }
948    #[derive(Clone, PartialEq, ::prost::Oneof)]
949    pub enum Query {
950        #[prost(string, tag = "1")]
951        SearchText(::prost::alloc::string::String),
952        #[prost(string, tag = "2")]
953        Label(::prost::alloc::string::String),
954        #[prost(message, tag = "3")]
955        Property(super::super::super::super::types::Property),
956        #[prost(message, tag = "4")]
957        And(ProcedureExecutionSearchAndQuery),
958        #[prost(message, tag = "5")]
959        Or(ProcedureExecutionSearchOrQuery),
960        #[prost(string, tag = "6")]
961        Workspace(::prost::alloc::string::String),
962        #[prost(string, tag = "7")]
963        ProcedureRid(::prost::alloc::string::String),
964        #[prost(string, tag = "8")]
965        CommitId(::prost::alloc::string::String),
966        #[prost(string, tag = "9")]
967        CreatedBy(::prost::alloc::string::String),
968    }
969}
970#[derive(Clone, Copy, PartialEq, ::prost::Message)]
971pub struct ProcedureExecutionSortOptions {
972    #[prost(bool, tag = "1")]
973    pub is_descending: bool,
974    #[prost(enumeration = "SearchProcedureExecutionsSortField", tag = "2")]
975    pub sort_field: i32,
976}
977#[derive(Clone, PartialEq, ::prost::Message)]
978pub struct SearchProcedureExecutionsRequest {
979    #[prost(message, optional, tag = "1")]
980    pub query: ::core::option::Option<ProcedureExecutionSearchQuery>,
981    #[prost(message, optional, tag = "2")]
982    pub sort_options: ::core::option::Option<ProcedureExecutionSortOptions>,
983    /// Page sizes greater than 1_000 will be rejected. Default pageSize is 100.
984    #[prost(int32, optional, tag = "3")]
985    pub page_size: ::core::option::Option<i32>,
986    #[prost(string, optional, tag = "4")]
987    pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
988}
989#[derive(Clone, PartialEq, ::prost::Message)]
990pub struct SearchProcedureExecutionsResponse {
991    #[prost(message, repeated, tag = "1")]
992    pub procedure_executions: ::prost::alloc::vec::Vec<ProcedureExecutionMetadata>,
993    #[prost(string, optional, tag = "2")]
994    pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
995}
996#[derive(Clone, PartialEq, ::prost::Message)]
997pub struct BatchGetProcedureExecutionMetadataRequest {
998    #[prost(string, repeated, tag = "1")]
999    pub procedure_execution_rids: ::prost::alloc::vec::Vec<
1000        ::prost::alloc::string::String,
1001    >,
1002}
1003#[derive(Clone, PartialEq, ::prost::Message)]
1004pub struct BatchGetProcedureExecutionMetadataResponse {
1005    #[prost(message, repeated, tag = "1")]
1006    pub procedure_executions: ::prost::alloc::vec::Vec<ProcedureExecutionMetadata>,
1007}
1008#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
1009#[repr(i32)]
1010pub enum SearchProcedureExecutionsSortField {
1011    Unspecified = 0,
1012    CreatedAt = 1,
1013    StartedAt = 2,
1014    FinishedAt = 3,
1015    UpdatedAt = 4,
1016}
1017impl SearchProcedureExecutionsSortField {
1018    /// String value of the enum field names used in the ProtoBuf definition.
1019    ///
1020    /// The values are not transformed in any way and thus are considered stable
1021    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
1022    pub fn as_str_name(&self) -> &'static str {
1023        match self {
1024            Self::Unspecified => "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UNSPECIFIED",
1025            Self::CreatedAt => "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_CREATED_AT",
1026            Self::StartedAt => "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_STARTED_AT",
1027            Self::FinishedAt => "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_FINISHED_AT",
1028            Self::UpdatedAt => "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UPDATED_AT",
1029        }
1030    }
1031    /// Creates an enum from field names used in the ProtoBuf definition.
1032    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
1033        match value {
1034            "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UNSPECIFIED" => {
1035                Some(Self::Unspecified)
1036            }
1037            "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_CREATED_AT" => Some(Self::CreatedAt),
1038            "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_STARTED_AT" => Some(Self::StartedAt),
1039            "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_FINISHED_AT" => {
1040                Some(Self::FinishedAt)
1041            }
1042            "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UPDATED_AT" => Some(Self::UpdatedAt),
1043            _ => None,
1044        }
1045    }
1046}
1047#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
1048#[repr(i32)]
1049pub enum ProcedureExecutionsServiceError {
1050    Unspecified = 0,
1051    NotFound = 1,
1052    ProcNotFound = 2,
1053    NodeNotFound = 3,
1054    InvalidNode = 4,
1055    InvalidGraph = 5,
1056    InvalidStepTransition = 6,
1057    InvalidSearchToken = 7,
1058    InvalidStepUpdate = 8,
1059}
1060impl ProcedureExecutionsServiceError {
1061    /// String value of the enum field names used in the ProtoBuf definition.
1062    ///
1063    /// The values are not transformed in any way and thus are considered stable
1064    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
1065    pub fn as_str_name(&self) -> &'static str {
1066        match self {
1067            Self::Unspecified => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_UNSPECIFIED",
1068            Self::NotFound => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_NOT_FOUND",
1069            Self::ProcNotFound => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_PROC_NOT_FOUND",
1070            Self::NodeNotFound => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_NODE_NOT_FOUND",
1071            Self::InvalidNode => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_NODE",
1072            Self::InvalidGraph => "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_GRAPH",
1073            Self::InvalidStepTransition => {
1074                "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_STEP_TRANSITION"
1075            }
1076            Self::InvalidSearchToken => {
1077                "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_SEARCH_TOKEN"
1078            }
1079            Self::InvalidStepUpdate => {
1080                "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_STEP_UPDATE"
1081            }
1082        }
1083    }
1084    /// Creates an enum from field names used in the ProtoBuf definition.
1085    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
1086        match value {
1087            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_UNSPECIFIED" => Some(Self::Unspecified),
1088            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_NOT_FOUND" => Some(Self::NotFound),
1089            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_PROC_NOT_FOUND" => {
1090                Some(Self::ProcNotFound)
1091            }
1092            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_NODE_NOT_FOUND" => {
1093                Some(Self::NodeNotFound)
1094            }
1095            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_NODE" => Some(Self::InvalidNode),
1096            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_GRAPH" => {
1097                Some(Self::InvalidGraph)
1098            }
1099            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_STEP_TRANSITION" => {
1100                Some(Self::InvalidStepTransition)
1101            }
1102            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_SEARCH_TOKEN" => {
1103                Some(Self::InvalidSearchToken)
1104            }
1105            "PROCEDURE_EXECUTIONS_SERVICE_ERROR_INVALID_STEP_UPDATE" => {
1106                Some(Self::InvalidStepUpdate)
1107            }
1108            _ => None,
1109        }
1110    }
1111}
1112/// Generated client implementations.
1113pub mod procedure_executions_service_client {
1114    #![allow(
1115        unused_variables,
1116        dead_code,
1117        missing_docs,
1118        clippy::wildcard_imports,
1119        clippy::let_unit_value,
1120    )]
1121    use tonic::codegen::*;
1122    use tonic::codegen::http::Uri;
1123    /// Service for creating and managing procedure executions.
1124    #[derive(Debug, Clone)]
1125    pub struct ProcedureExecutionsServiceClient<T> {
1126        inner: tonic::client::Grpc<T>,
1127    }
1128    impl ProcedureExecutionsServiceClient<tonic::transport::Channel> {
1129        /// Attempt to create a new client by connecting to a given endpoint.
1130        pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
1131        where
1132            D: TryInto<tonic::transport::Endpoint>,
1133            D::Error: Into<StdError>,
1134        {
1135            let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
1136            Ok(Self::new(conn))
1137        }
1138    }
1139    impl<T> ProcedureExecutionsServiceClient<T>
1140    where
1141        T: tonic::client::GrpcService<tonic::body::Body>,
1142        T::Error: Into<StdError>,
1143        T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
1144        <T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
1145    {
1146        pub fn new(inner: T) -> Self {
1147            let inner = tonic::client::Grpc::new(inner);
1148            Self { inner }
1149        }
1150        pub fn with_origin(inner: T, origin: Uri) -> Self {
1151            let inner = tonic::client::Grpc::with_origin(inner, origin);
1152            Self { inner }
1153        }
1154        pub fn with_interceptor<F>(
1155            inner: T,
1156            interceptor: F,
1157        ) -> ProcedureExecutionsServiceClient<InterceptedService<T, F>>
1158        where
1159            F: tonic::service::Interceptor,
1160            T::ResponseBody: Default,
1161            T: tonic::codegen::Service<
1162                http::Request<tonic::body::Body>,
1163                Response = http::Response<
1164                    <T as tonic::client::GrpcService<tonic::body::Body>>::ResponseBody,
1165                >,
1166            >,
1167            <T as tonic::codegen::Service<
1168                http::Request<tonic::body::Body>,
1169            >>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
1170        {
1171            ProcedureExecutionsServiceClient::new(
1172                InterceptedService::new(inner, interceptor),
1173            )
1174        }
1175        /// Compress requests with the given encoding.
1176        ///
1177        /// This requires the server to support it otherwise it might respond with an
1178        /// error.
1179        #[must_use]
1180        pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
1181            self.inner = self.inner.send_compressed(encoding);
1182            self
1183        }
1184        /// Enable decompressing responses.
1185        #[must_use]
1186        pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
1187            self.inner = self.inner.accept_compressed(encoding);
1188            self
1189        }
1190        /// Limits the maximum size of a decoded message.
1191        ///
1192        /// Default: `4MB`
1193        #[must_use]
1194        pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
1195            self.inner = self.inner.max_decoding_message_size(limit);
1196            self
1197        }
1198        /// Limits the maximum size of an encoded message.
1199        ///
1200        /// Default: `usize::MAX`
1201        #[must_use]
1202        pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
1203            self.inner = self.inner.max_encoding_message_size(limit);
1204            self
1205        }
1206        /// Create a new procedure execution from a procedure
1207        pub async fn create_procedure_execution(
1208            &mut self,
1209            request: impl tonic::IntoRequest<super::CreateProcedureExecutionRequest>,
1210        ) -> std::result::Result<
1211            tonic::Response<super::CreateProcedureExecutionResponse>,
1212            tonic::Status,
1213        > {
1214            self.inner
1215                .ready()
1216                .await
1217                .map_err(|e| {
1218                    tonic::Status::unknown(
1219                        format!("Service was not ready: {}", e.into()),
1220                    )
1221                })?;
1222            let codec = tonic::codec::ProstCodec::default();
1223            let path = http::uri::PathAndQuery::from_static(
1224                "/nominal.procedures.executions.v1.ProcedureExecutionsService/CreateProcedureExecution",
1225            );
1226            let mut req = request.into_request();
1227            req.extensions_mut()
1228                .insert(
1229                    GrpcMethod::new(
1230                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1231                        "CreateProcedureExecution",
1232                    ),
1233                );
1234            self.inner.unary(req, path, codec).await
1235        }
1236        /// Get a procedure execution by its RID
1237        pub async fn get_procedure_execution(
1238            &mut self,
1239            request: impl tonic::IntoRequest<super::GetProcedureExecutionRequest>,
1240        ) -> std::result::Result<
1241            tonic::Response<super::GetProcedureExecutionResponse>,
1242            tonic::Status,
1243        > {
1244            self.inner
1245                .ready()
1246                .await
1247                .map_err(|e| {
1248                    tonic::Status::unknown(
1249                        format!("Service was not ready: {}", e.into()),
1250                    )
1251                })?;
1252            let codec = tonic::codec::ProstCodec::default();
1253            let path = http::uri::PathAndQuery::from_static(
1254                "/nominal.procedures.executions.v1.ProcedureExecutionsService/GetProcedureExecution",
1255            );
1256            let mut req = request.into_request();
1257            req.extensions_mut()
1258                .insert(
1259                    GrpcMethod::new(
1260                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1261                        "GetProcedureExecution",
1262                    ),
1263                );
1264            self.inner.unary(req, path, codec).await
1265        }
1266        /// Update the metadata of a procedure execution
1267        pub async fn update_procedure_execution_metadata(
1268            &mut self,
1269            request: impl tonic::IntoRequest<
1270                super::UpdateProcedureExecutionMetadataRequest,
1271            >,
1272        ) -> std::result::Result<
1273            tonic::Response<super::UpdateProcedureExecutionMetadataResponse>,
1274            tonic::Status,
1275        > {
1276            self.inner
1277                .ready()
1278                .await
1279                .map_err(|e| {
1280                    tonic::Status::unknown(
1281                        format!("Service was not ready: {}", e.into()),
1282                    )
1283                })?;
1284            let codec = tonic::codec::ProstCodec::default();
1285            let path = http::uri::PathAndQuery::from_static(
1286                "/nominal.procedures.executions.v1.ProcedureExecutionsService/UpdateProcedureExecutionMetadata",
1287            );
1288            let mut req = request.into_request();
1289            req.extensions_mut()
1290                .insert(
1291                    GrpcMethod::new(
1292                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1293                        "UpdateProcedureExecutionMetadata",
1294                    ),
1295                );
1296            self.inner.unary(req, path, codec).await
1297        }
1298        /// Heavy-handed update method for procedure execution
1299        /// TODO(pchen): This isn't the expected final endpoint, this is just for editing the graph while we iterate
1300        /// There likely be additional fine-grained methods for editing the procedure
1301        pub async fn update_procedure_execution(
1302            &mut self,
1303            request: impl tonic::IntoRequest<super::UpdateProcedureExecutionRequest>,
1304        ) -> std::result::Result<
1305            tonic::Response<super::UpdateProcedureExecutionResponse>,
1306            tonic::Status,
1307        > {
1308            self.inner
1309                .ready()
1310                .await
1311                .map_err(|e| {
1312                    tonic::Status::unknown(
1313                        format!("Service was not ready: {}", e.into()),
1314                    )
1315                })?;
1316            let codec = tonic::codec::ProstCodec::default();
1317            let path = http::uri::PathAndQuery::from_static(
1318                "/nominal.procedures.executions.v1.ProcedureExecutionsService/UpdateProcedureExecution",
1319            );
1320            let mut req = request.into_request();
1321            req.extensions_mut()
1322                .insert(
1323                    GrpcMethod::new(
1324                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1325                        "UpdateProcedureExecution",
1326                    ),
1327                );
1328            self.inner.unary(req, path, codec).await
1329        }
1330        /// Update the status of a step in a procedure execution. This can only be done if the step is NOT_STARTED,
1331        /// IN_PROGRESS, or SUBMITTED. Other state transitions are managed by the backend.
1332        pub async fn update_step(
1333            &mut self,
1334            request: impl tonic::IntoRequest<super::UpdateStepRequest>,
1335        ) -> std::result::Result<
1336            tonic::Response<super::UpdateStepResponse>,
1337            tonic::Status,
1338        > {
1339            self.inner
1340                .ready()
1341                .await
1342                .map_err(|e| {
1343                    tonic::Status::unknown(
1344                        format!("Service was not ready: {}", e.into()),
1345                    )
1346                })?;
1347            let codec = tonic::codec::ProstCodec::default();
1348            let path = http::uri::PathAndQuery::from_static(
1349                "/nominal.procedures.executions.v1.ProcedureExecutionsService/UpdateStep",
1350            );
1351            let mut req = request.into_request();
1352            req.extensions_mut()
1353                .insert(
1354                    GrpcMethod::new(
1355                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1356                        "UpdateStep",
1357                    ),
1358                );
1359            self.inner.unary(req, path, codec).await
1360        }
1361        /// This should only be called by the backend to update the success_condition_status of a step.
1362        /// This can only be done if the step is SUBMITTED.
1363        pub async fn update_step_success_condition_status(
1364            &mut self,
1365            request: impl tonic::IntoRequest<
1366                super::UpdateStepSuccessConditionStatusRequest,
1367            >,
1368        ) -> std::result::Result<
1369            tonic::Response<super::UpdateStepSuccessConditionStatusResponse>,
1370            tonic::Status,
1371        > {
1372            self.inner
1373                .ready()
1374                .await
1375                .map_err(|e| {
1376                    tonic::Status::unknown(
1377                        format!("Service was not ready: {}", e.into()),
1378                    )
1379                })?;
1380            let codec = tonic::codec::ProstCodec::default();
1381            let path = http::uri::PathAndQuery::from_static(
1382                "/nominal.procedures.executions.v1.ProcedureExecutionsService/UpdateStepSuccessConditionStatus",
1383            );
1384            let mut req = request.into_request();
1385            req.extensions_mut()
1386                .insert(
1387                    GrpcMethod::new(
1388                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1389                        "UpdateStepSuccessConditionStatus",
1390                    ),
1391                );
1392            self.inner.unary(req, path, codec).await
1393        }
1394        /// Search for procedure executions
1395        pub async fn search_procedure_executions(
1396            &mut self,
1397            request: impl tonic::IntoRequest<super::SearchProcedureExecutionsRequest>,
1398        ) -> std::result::Result<
1399            tonic::Response<super::SearchProcedureExecutionsResponse>,
1400            tonic::Status,
1401        > {
1402            self.inner
1403                .ready()
1404                .await
1405                .map_err(|e| {
1406                    tonic::Status::unknown(
1407                        format!("Service was not ready: {}", e.into()),
1408                    )
1409                })?;
1410            let codec = tonic::codec::ProstCodec::default();
1411            let path = http::uri::PathAndQuery::from_static(
1412                "/nominal.procedures.executions.v1.ProcedureExecutionsService/SearchProcedureExecutions",
1413            );
1414            let mut req = request.into_request();
1415            req.extensions_mut()
1416                .insert(
1417                    GrpcMethod::new(
1418                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1419                        "SearchProcedureExecutions",
1420                    ),
1421                );
1422            self.inner.unary(req, path, codec).await
1423        }
1424        /// Batch get procedure execution metadata
1425        pub async fn batch_get_procedure_execution_metadata(
1426            &mut self,
1427            request: impl tonic::IntoRequest<
1428                super::BatchGetProcedureExecutionMetadataRequest,
1429            >,
1430        ) -> std::result::Result<
1431            tonic::Response<super::BatchGetProcedureExecutionMetadataResponse>,
1432            tonic::Status,
1433        > {
1434            self.inner
1435                .ready()
1436                .await
1437                .map_err(|e| {
1438                    tonic::Status::unknown(
1439                        format!("Service was not ready: {}", e.into()),
1440                    )
1441                })?;
1442            let codec = tonic::codec::ProstCodec::default();
1443            let path = http::uri::PathAndQuery::from_static(
1444                "/nominal.procedures.executions.v1.ProcedureExecutionsService/BatchGetProcedureExecutionMetadata",
1445            );
1446            let mut req = request.into_request();
1447            req.extensions_mut()
1448                .insert(
1449                    GrpcMethod::new(
1450                        "nominal.procedures.executions.v1.ProcedureExecutionsService",
1451                        "BatchGetProcedureExecutionMetadata",
1452                    ),
1453                );
1454            self.inner.unary(req, path, codec).await
1455        }
1456    }
1457}
nominal_api/proto/nominal.procedures.executions.v1.rs

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