View Source Runbox.Runtime.OutputAction (runbox v22.0.0)

Output Action for internal use by Runtime

Summary

Types

t()

Runtime Output Action

Functions

attributes_access_tags_valid?(access_tags)

Returns true if provided attributes access tags are valid.

incident_access_tags_valid?(tags)

Checks whether access tags used in Incident output actions are valid.

new(params, timestamp, scenario_id, run_id)

Creates a new output action.

oa_body?(params)

Returns true if valid output action body.

valid?(arg1)

Returns true if valid output action.

Types

t()

@type t() :: %Runbox.Runtime.OutputAction{
  body:
    Runbox.Scenario.OutputAction.oa_params()
    | Runbox.Scenario.OutputAction.BadOutputAction.t(),
  run_id: String.t(),
  scenario_id: String.t(),
  timestamp: integer()
}

Runtime Output Action

Functions

attributes_access_tags_valid?(access_tags)

@spec attributes_access_tags_valid?(Runbox.Scenario.OutputAction.access_tags()) ::
  boolean()

Returns true if provided attributes access tags are valid.

incident_access_tags_valid?(tags)

@spec incident_access_tags_valid?(tags :: any()) :: boolean()

Checks whether access tags used in Incident output actions are valid.

new(params, timestamp, scenario_id, run_id)

@spec new(
  params :: Runbox.Scenario.OutputAction.oa_params(),
  integer(),
  String.t(),
  String.t()
) :: t()

Creates a new output action.

To produce a valid output action, the params have to be one of the accepted structs. See the documentation of the particular structs for details.

If the params are not one of the accepted structs or some of the fields do not pass validation, it returns an output action with body set to Runbox.Scenario.OutputAction.BadOutputAction.t/0 with original params inside.

oa_body?(params)

@spec oa_body?(Runbox.Scenario.OutputAction.oa_params() | any()) :: boolean()

Returns true if valid output action body.

valid?(arg1)

@spec valid?(t() | any()) :: boolean()

Returns true if valid output action.