Module v1 

Modules

asset_field

Nested message and enum types in AssetField.

asset_reference

Nested message and enum types in AssetReference.

auto_proceed_config

Nested message and enum types in AutoProceedConfig.

auto_start_config

Nested message and enum types in AutoStartConfig.

checklist_reference

Nested message and enum types in ChecklistReference.

completion_action_config

Nested message and enum types in CompletionActionConfig.

create_run_config

Nested message and enum types in CreateRunConfig.

double_field

Nested message and enum types in DoubleField.

form_field

Nested message and enum types in FormField.

integration_reference

Nested message and enum types in IntegrationReference.

multi_asset_reference

Nested message and enum types in MultiAssetReference.

multi_checklist_reference

Nested message and enum types in MultiChecklistReference.

multi_enum_field

Nested message and enum types in MultiEnumField.

multi_integration_reference

Nested message and enum types in MultiIntegrationReference.

multi_run_reference

Nested message and enum types in MultiRunReference.

multi_string_reference

Nested message and enum types in MultiStringReference.

multi_workbook_template_reference

Nested message and enum types in MultiWorkbookTemplateReference.

nested_procedure_node

Nested message and enum types in NestedProcedureNode.

procedure_node

Nested message and enum types in ProcedureNode.

procedure_search_query

Nested message and enum types in ProcedureSearchQuery.

procedure_step_content

Nested message and enum types in ProcedureStepContent.

procedures_service_client

Generated client implementations.

run_reference

Nested message and enum types in RunReference.

select_or_create_asset_step

Nested message and enum types in SelectOrCreateAssetStep.

single_enum_field

Nested message and enum types in SingleEnumField.

start_ingest_step

Nested message and enum types in StartIngestStep.

string_reference

Nested message and enum types in StringReference.

success_condition

Nested message and enum types in SuccessCondition.

text_field

Nested message and enum types in TextField.

time_range_reference

Nested message and enum types in TimeRangeReference.

workbook_template_reference

Nested message and enum types in WorkbookTemplateReference.

Structs

AndSuccessCondition

All conditions within must be met for the step to be succeeded.

ApplyChecklistsConfig

An action to apply one or more checklists to one or more runs when a step is completed.

ApplyWorkbookTemplatesConfig

An action to apply one or more workbook templates to one or more runs when a step is completed.

ArchiveProceduresRequest

ArchiveProceduresResponse

AssetField

A field to select a single asset.

AssetReference

A reference to a single asset

AutoProceedConfig

AutoProceedConfig is a configuration that determines whether a step should automatically proceed (submit the contents and check success_conditions) when some set of criteria are met. By default this will be disabled.

AutoStartConfig

AutoStartConfig is a configuration that determines whether a step should be automatically moved from NOT_STARTED to IN_PROGRESS when some set of criteria are met. By default this will be all_parents

CheckboxField

A field to capture a boolean value.

ChecklistReference

A reference to a single checklist

CommitRequest

CommitResponse

CompletionActionConfig

An action that will be taken when a step transitions to a completed state (succeeded, errored, or skipped). These actions are executed after the step contents are submitted and the PassCondition (if any) is satisfied. These actions are executed synchronously with the state transition and generally should be quick to complete. Almost all actions will be executed only if the step transitions to SUCCEEDED. The exception is CreateEvent, which will be executed for all terminal states.

CreateEventConfig

An action to create an event when a step is completed. The completion state of the step is mapped to the event’s EventType as follows:

CreateProcedureRequest

CreateProcedureResponse

CreateRunConfig

An action to create a run when a step is completed.

DoubleField

A field to capture a double value.

EnumFieldButtonsInputType

EnumFieldMenuInputType

FormField

A field to be filled out by the user.

FormStep

A form step consists of a set of fields to be filled out by the user.

GetProcedureAsNestedRequest

GetProcedureAsNestedResponse

GetProcedureRequest

GetProcedureResponse

IngestJobSuccessCondition

The step will succeed when the associated ingest job succeeds. If the ingest job fails, the step will move to ERRORED.

IntField

A field to capture an int value.

IntegrationReference

A reference to a notification Integration

MergeToMainRequest

MergeToMainResponse

MultiAssetReference

A reference to multiple assets

MultiChecklistReference

A reference to multiple checklists

MultiEnumField

A field to capture one or more of several options.

MultiIntegrationReference

A reference to multiple notification Integrations

MultiRunReference

A reference to multiple runs

MultiStringReference

A reference to multiple string values

MultiWorkbookTemplateReference

A reference to multiple workbook templates

NestedProcedure

A simplified version of procedure state that is currently used for procedure authoring. In this form, the graph is a completely linear structure where each step depends solely on the preceding step.

NestedProcedureNode

A section or a step in a NestedProcedure.

NodeList

A list of node IDs.

ParseNestedProcedureRequest

ParseNestedProcedureResponse

PresetAssetFieldOptions

A limited set of options to choose from, with an optional default option.

Procedure

A procedure describes a series of steps to be performed, typically in a specific order,

ProcedureDisplayGraph

A simpler representation of the procedure graph that is used for display in a UI.

ProcedureMetadata

Metadata about a procedure that is not part of the versioned state.

ProcedureNode

A procedure node is either a section or a step.

ProcedureSearchQuery

ProcedureSectionNode

A procedure section node visually groups other sections and steps.

ProcedureState

ProcedureState is the versioned state of a procedure template.

ProcedureStepContent

The content of a procedure step. This typically involves some form of user interaction/input.

ProcedureStepNode

A procedure step node represents a step in the procedure.

RunReference

A reference to a single run

SaveWorkingStateRequest

SaveWorkingStateResponse

SearchProceduresRequest

SearchProceduresResponse

SearchProceduresSortOptions

SelectOrCreateAssetStep

The user will be prompted to select an existing asset or create a new asset.

SendNotificationConfig

An action to send a notification to one or more integrations when a step is completed.

SingleEnumField

A field to capture one of several options.

StartIngestStep

The user will be prompted to start an ingest job in the frontend and the output of the step will be the rid of the created ingest job.

StringReference

A reference to a single string value

SuccessCondition

The condition that must be met for a step to succeed after submitting its contents.

TextField

A field to capture a string value.

TextFieldMarkdownInputType

TextFieldSimpleInputType

TimeRangeReference

A reference to a time range

TimerSuccessCondition

A timer condition that will succeed the step after a specified duration.

UnarchiveProceduresRequest

UnarchiveProceduresResponse

UpdateProcedureMetadataRequest

UpdateProcedureMetadataResponse

WorkbookTemplateReference

A reference to a single workbook template

Enums

ProceduresServiceError

SearchProceduresSortField