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

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