Module v1 

Modules

asset_field_value

Nested message and enum types in AssetFieldValue.

completion_action_state

Nested message and enum types in CompletionActionState.

completion_action_status

Nested message and enum types in CompletionActionStatus.

execution_step_state

Nested message and enum types in ExecutionStepState.

field_output

Nested message and enum types in FieldOutput.

file_upload_field_value

Nested message and enum types in FileUploadFieldValue.

form_field_value

Nested message and enum types in FormFieldValue.

procedure_async_task

Nested message and enum types in ProcedureAsyncTask.

procedure_execution_node

Nested message and enum types in ProcedureExecutionNode.

procedure_execution_search_query

Nested message and enum types in ProcedureExecutionSearchQuery.

procedure_executions_service_client

Generated client implementations.

step_content_value

Nested message and enum types in StepContentValue.

success_condition_status

Nested message and enum types in SuccessConditionStatus.

target_step_state_request

Nested message and enum types in TargetStepStateRequest.

Structs

AndSuccessCondition

ApplyChecklistsResult

An ApplyChecklists action results in a list of DataReviewRids if successful.

ApplyWorkbookTemplatesResult

An ApplyWorkbookTemplates action results in a list of workbook RIDs if successful.

AssetFieldValue

BatchGetProcedureExecutionMetadataRequest

BatchGetProcedureExecutionMetadataResponse

CheckboxFieldValue

CompletionActionState

CompletionActionStatus

The status of a completion action and its result (if any).

ConditionObservation

CreateEventResult

A CreateEvent action results in an EventRid if successful.

CreateProcedureExecutionRequest

CreateProcedureExecutionResponse

CreateRunResult

A CreateRun action results in a RunRid if successful.

DoubleFieldValue

ExecutionStepErrored

An execution step reaches the ERRORED state if something went wrong while trying to complete the step. This could be due to a badly configured procedure, an error/timeout in the completion condition, or an error/timeout in one of the completion actions. This is a terminal state, the step’s values cannot be modified by the user.

ExecutionStepInProgress

An execution step is in the IN_PROGRESS state once it has been started from NOT_STARTED, either manually or automatically. In this state, the step’s values can be modified by the user.

ExecutionStepNotStarted

All execution steps start in the NOT_STARTED state. In this state, the step’s values can be modified by the user.

ExecutionStepSkipped

An execution step is in the SKIPPED state if it was skipped by a user. An execution step cannot be skipped if it is in a terminal state (SUCCEEDED or ERRORED). This is a terminal state, the step’s values cannot be modified by the user.

ExecutionStepState

The read-side state for an execution step. Here is the state machine: All steps start in the NOT_STARTED state. From NOT_STARTED, a step can transition to IN_PROGRESS or SKIPPED.

ExecutionStepSubmitted

An execution step is in the SUBMITTED state once it has been submitted from the IN_PROGRESS state, either manually or automatically. In this state, the step’s values are considered submitted and cannot be modified by the user. In this state, the backend will monitor the completion condition (if any) and execute the completion actions (if any) once the condition is satisfied.

ExecutionStepSucceeded

An execution step reaches the SUCCEEDED state if all conditions were met and all actions successfully ran. This is a terminal state, the step’s values cannot be modified by the user.

FieldOutput

TODO(pchen): how to handle the value typing here The outputs of a field in a step. This is different from FormFieldValue in that this represents the resolved value after the step has been completed. Eg, this would contain an AssetRid while the FormFieldValue could contain an AssetReference

FileUploadFieldValue

Corresponds to usage of the upload api

FormFieldValue

The value chosen for a form field. This differs from FieldOutput in that this should map 1:1 with FormField types, while FieldOutput contains the resolved values after the execution step is complete.

FormStepValue

GetProcedureExecutionRequest

GetProcedureExecutionResponse

IntFieldValue

MultiEnumFieldValue

MultiFileUploadFieldValue

ProcedureAsyncTask

ProcedureExecution

ProcedureExecutionMetadata

ProcedureExecutionNode

A procedure execution node is either a section or a step.

ProcedureExecutionSearchQuery

ProcedureExecutionSectionNode

A section node is a visual grouping of other sections and steps.

ProcedureExecutionSortOptions

ProcedureExecutionState

ProcedureExecutionState is the state of an executing procedure.

ProcedureExecutionStepNode

Execution steps are the interactive steps in a procedure.

RepeatStepRequest

RepeatStepResponse

S3UploadFileValue

SearchProcedureExecutionsRequest

SearchProcedureExecutionsResponse

SelectOrCreateAssetStepValue

SingleEnumFieldValue

StartIngestStepValue

StartProcedureExecutionRequest

StartProcedureExecutionResponse

StepContentValue

The value for a step’s content. Should match the ProcedureStepNode type.

StepErroredRequest

StepInProgressRequest

StepSkippedRequest

StepSubmittedRequest

Strings

SuccessConditionCanceled

SuccessConditionFailed

SuccessConditionInProgress

SuccessConditionSatisfied

SuccessConditionStatus

Represents the current status of one or more nested completion conditions. Mirrors the recursive SuccessCondition in nominal.procedures.v1

SuccessConditionSubmitted

TargetStepStateRequest

A request to update the state of an execution step.

TextFieldValue

UpdateProcedureExecutionMetadataRequest

UpdateProcedureExecutionMetadataResponse

UpdateProcedureExecutionRequest

TODO(niwong to pchen): I made an “update metadata” endpoint separately above, I think it’d be nice to turn this into a dedicated endpoint for changing the state of the overall execution (start, succeed, abort, fail) I also think in general we shouldn’t be updating the entire ProcedureExecutionState but rather leveraging updateStep. TODO(WB-1879): allow to just update the global fields within the ProcExecState.

UpdateProcedureExecutionResponse

UpdateStepRequest

UpdateStepResponse

UpdateStepSuccessConditionStatusRequest

UpdateStepSuccessConditionStatusResponse

Enums

ProcedureExecutionsServiceError

RepeatStepBehavior

SearchProcedureExecutionsSortField