FlowRunner.Spec.Flow (flow_runner v6.15.1)

A Flow is a set of connected blocks as defined by the Flow Spec.

Summary

Types

t()

Functions

cast!(params)

cast!(module, map)

Cast the received fields to their internal representation

cast_datetime!(params, field_name)

fetch_block(flow, block_uuid)

load!(blocks_module, list)

Load the map or list of maps into Elixir.FlowRunner.Spec.Flow structs.

valid?(self)

validate!(blocks_module, impl)

Validate a Elixir.FlowRunner.Spec.Flow struct using Vex.validate

Types

t()

@type t() :: %FlowRunner.Spec.Flow{
  blocks: [FlowRunner.Spec.Block.t()],
  exit_block_id: String.t(),
  first_block_id: String.t(),
  interaction_timeout: pos_integer(),
  label: String.t(),
  languages: [FlowRunner.Spec.Language.t()],
  last_modified: DateTime.t(),
  name: String.t(),
  supported_modes: [String.t()],
  uuid: String.t(),
  vendor_metadata: map()
}

Functions

cast!(params)

cast!(module, map)

@spec cast!(module(), map()) :: map()

Cast the received fields to their internal representation

cast_datetime!(params, field_name)

fetch_block(flow, block_uuid)

load!(blocks_module, list)

@spec load!(module(), map()) :: t()

@spec load!(module(), [map()]) :: [t()]

Load the map or list of maps into Elixir.FlowRunner.Spec.Flow structs.

valid?(self)

validate!(blocks_module, impl)

@spec validate!(blocks_module :: module(), t()) :: t()

Validate a Elixir.FlowRunner.Spec.Flow struct using Vex.validate