Safe Haskell	None
Language	GHC2021

Navi.Services.Custom.Toml

Description

This module provides toml configuration for the custom service.

Synopsis

data CustomToml = MkCustomToml {
- command :: Command
- errEventCfg :: Maybe ErrorNoteToml
- name :: Maybe Text
- parser :: Maybe CommandResultParserToml
- pollInterval :: Maybe PollInterval
- repeatEventCfg :: Maybe (MultiRepeatEventToml Text)
- triggerNotes :: NonEmpty TriggerNoteToml
}
data TriggerNoteToml = MkTriggerNoteToml {
- trigger :: Text
- note :: NaviNote
}

Documentation

data CustomToml Source #

TOML for the custom service.

Constructors

MkCustomToml

Fields

command :: Command
The command to run.
errEventCfg :: Maybe ErrorNoteToml
Determines how we handle errors.
name :: Maybe Text
An optional name to be used with logging.
parser :: Maybe CommandResultParserToml
Custom parsing.
pollInterval :: Maybe PollInterval
The poll interval.
repeatEventCfg :: Maybe (MultiRepeatEventToml Text)
Determines how we treat repeat alerts.
triggerNotes :: NonEmpty TriggerNoteToml
The alert triggers.

Instances

Instances details

Show CustomToml Source #
Instance details Defined in Navi.Services.Custom.Toml Methods showsPrec :: Int -> CustomToml -> ShowS # show :: CustomToml -> String # showList :: [CustomToml] -> ShowS #
Eq CustomToml Source #
Instance details Defined in Navi.Services.Custom.Toml Methods (==) :: CustomToml -> CustomToml -> Bool # (/=) :: CustomToml -> CustomToml -> Bool #
DecodeTOML CustomToml Source #	Since: 0.1
Instance details Defined in Navi.Services.Custom.Toml Methods tomlDecoder :: Decoder CustomToml Source #
(k ~ A_Lens, a ~ Command, b ~ Command) => LabelOptic "command" k CustomToml CustomToml a b Source #
Instance details Defined in Navi.Services.Custom.Toml Methods labelOptic :: Optic k NoIx CustomToml CustomToml a b Source #
(k ~ A_Lens, a ~ Maybe ErrorNoteToml, b ~ Maybe ErrorNoteToml) => LabelOptic "errEventCfg" k CustomToml CustomToml a b Source #
Instance details Defined in Navi.Services.Custom.Toml Methods labelOptic :: Optic k NoIx CustomToml CustomToml a b Source #
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "name" k CustomToml CustomToml a b Source #
Instance details Defined in Navi.Services.Custom.Toml Methods labelOptic :: Optic k NoIx CustomToml CustomToml a b Source #
(k ~ A_Lens, a ~ Maybe CommandResultParserToml, b ~ Maybe CommandResultParserToml) => LabelOptic "parser" k CustomToml CustomToml a b Source #
Instance details Defined in Navi.Services.Custom.Toml Methods labelOptic :: Optic k NoIx CustomToml CustomToml a b Source #
(k ~ A_Lens, a ~ Maybe PollInterval, b ~ Maybe PollInterval) => LabelOptic "pollInterval" k CustomToml CustomToml a b Source #
Instance details Defined in Navi.Services.Custom.Toml Methods labelOptic :: Optic k NoIx CustomToml CustomToml a b Source #
(k ~ A_Lens, a ~ Maybe (MultiRepeatEventToml Text), b ~ Maybe (MultiRepeatEventToml Text)) => LabelOptic "repeatEventCfg" k CustomToml CustomToml a b Source #
Instance details Defined in Navi.Services.Custom.Toml Methods labelOptic :: Optic k NoIx CustomToml CustomToml a b Source #
(k ~ A_Lens, a ~ NonEmpty TriggerNoteToml, b ~ NonEmpty TriggerNoteToml) => LabelOptic "triggerNotes" k CustomToml CustomToml a b Source #
Instance details Defined in Navi.Services.Custom.Toml Methods labelOptic :: Optic k NoIx CustomToml CustomToml a b Source #

data TriggerNoteToml Source #

TOML for alerts.

Constructors

MkTriggerNoteToml
Fields trigger :: Text The text that triggers an alert. note :: NaviNote The notification to send when triggered.

Instances

Instances details

Show TriggerNoteToml Source #
Instance details Defined in Navi.Services.Custom.Toml Methods showsPrec :: Int -> TriggerNoteToml -> ShowS # show :: TriggerNoteToml -> String # showList :: [TriggerNoteToml] -> ShowS #
Eq TriggerNoteToml Source #
Instance details Defined in Navi.Services.Custom.Toml Methods (==) :: TriggerNoteToml -> TriggerNoteToml -> Bool # (/=) :: TriggerNoteToml -> TriggerNoteToml -> Bool #
DecodeTOML TriggerNoteToml Source #	Since: 0.1
Instance details Defined in Navi.Services.Custom.Toml Methods tomlDecoder :: Decoder TriggerNoteToml Source #
(k ~ A_Lens, a ~ NaviNote, b ~ NaviNote) => LabelOptic "note" k TriggerNoteToml TriggerNoteToml a b Source #
Instance details Defined in Navi.Services.Custom.Toml Methods labelOptic :: Optic k NoIx TriggerNoteToml TriggerNoteToml a b Source #
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "trigger" k TriggerNoteToml TriggerNoteToml a b Source #
Instance details Defined in Navi.Services.Custom.Toml Methods labelOptic :: Optic k NoIx TriggerNoteToml TriggerNoteToml a b Source #