Struct ProcedureStepNode 

pub struct ProcedureStepNode {
    pub id: String,
    pub title: String,
    pub content: Option<ProcedureStepContent>,
    pub output_id: Option<String>,
    pub description: Option<String>,
    pub is_required: Option<bool>,
    pub auto_start: Option<AutoStartConfig>,
    pub initial_auto_proceed_config: Option<AutoProceedConfig>,
    pub success_condition: Option<SuccessCondition>,
    pub completion_action_configs: Vec<CompletionActionConfig>,
}

A procedure step node represents a step in the procedure.

Fields

id: String

Unique identifier for this node in the procedure graph.

title: String

Title of this step

content: Option<ProcedureStepContent>

The content of this step.

output_id: Option<String>

If set, other steps can reference this step’s outputs using “{output_id}.{field_id}”. Output_id must be globally unique across all steps in the procedure. During execution, we also enforce that the output_id is unique across all non-outdated steps.

description: Option<String>

Optional long-form description for this step

is_required: Option<bool>

is_required defaults to false, meaning that the step may be skipped

auto_start: Option<AutoStartConfig>

Configuration for if and how the step should automatically transition from NOT_STARTED to IN_PROGRESS By default, this will be all_parents.

initial_auto_proceed_config: Option<AutoProceedConfig>

Configuration for if and how the step should automatically submit the step contents when requirements are met. By default, this will be disabled.

success_condition: Option<SuccessCondition>

Configuration for whether the step will require a condition to be met for the step to be completed By default, this is not set, meaning that the step will not wait on any conditions before completing.

completion_action_configs: Vec<CompletionActionConfig>

Configuration for the actions to take when the step transitions to a completed state (SUCCEEDED, ERRORED, SKIPPED) By default, there are no actions.

Implementations

impl ProcedureStepNode

pub fn output_id(&self) -> &str

Returns the value of output_id, or the default value if output_id is unset.

pub fn description(&self) -> &str

Returns the value of description, or the default value if description is unset.

pub fn is_required(&self) -> bool

Returns the value of is_required, or the default value if is_required is unset.

Trait Implementations

impl Clone for ProcedureStepNode

fn clone(&self) -> ProcedureStepNode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProcedureStepNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProcedureStepNode

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProcedureStepNode

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ProcedureStepNode

fn eq(&self, other: &ProcedureStepNode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProcedureStepNode