RulesApi

hab_rs_api_client::apis::rules_api

Trait RulesApi 

Source 
pub trait RulesApi: Send + Sync {

Show 17 methods    // Required methods
    fn create_rule<'rule_dto, 'life0, 'async_trait>(
        &'life0 self,
        rule_dto: RuleDto,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<CreateRuleError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_dto: 'async_trait,
             'life0: 'async_trait;
    fn delete_rule<'rule_uid, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<DeleteRuleError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'life0: 'async_trait;
    fn enable_rule<'rule_uid, 'body, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
        body: &'body str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<EnableRuleError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'body: 'async_trait,
             'life0: 'async_trait;
    fn get_rule_actions<'rule_uid, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<ActionDto>, Error<GetRuleActionsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'life0: 'async_trait;
    fn get_rule_by_id<'rule_uid, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
    ) -> Pin<Box<dyn Future<Output = Result<EnrichedRuleDto, Error<GetRuleByIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'life0: 'async_trait;
    fn get_rule_conditions<'rule_uid, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<ConditionDto>, Error<GetRuleConditionsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'life0: 'async_trait;
    fn get_rule_configuration<'rule_uid, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
    ) -> Pin<Box<dyn Future<Output = Result<String, Error<GetRuleConfigurationError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'life0: 'async_trait;
    fn get_rule_module_by_id<'rule_uid, 'module_category, 'id, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
        module_category: &'module_category str,
        id: &'id str,
    ) -> Pin<Box<dyn Future<Output = Result<ModuleDto, Error<GetRuleModuleByIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'module_category: 'async_trait,
             'id: 'async_trait,
             'life0: 'async_trait;
    fn get_rule_module_config<'rule_uid, 'module_category, 'id, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
        module_category: &'module_category str,
        id: &'id str,
    ) -> Pin<Box<dyn Future<Output = Result<String, Error<GetRuleModuleConfigError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'module_category: 'async_trait,
             'id: 'async_trait,
             'life0: 'async_trait;
    fn get_rule_module_config_parameter<'rule_uid, 'module_category, 'id, 'param, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
        module_category: &'module_category str,
        id: &'id str,
        param: &'param str,
    ) -> Pin<Box<dyn Future<Output = Result<String, Error<GetRuleModuleConfigParameterError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'module_category: 'async_trait,
             'id: 'async_trait,
             'param: 'async_trait,
             'life0: 'async_trait;
    fn get_rule_triggers<'rule_uid, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<TriggerDto>, Error<GetRuleTriggersError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'life0: 'async_trait;
    fn get_rules<'prefix, 'tags, 'summary, 'static_data_only, 'life0, 'async_trait>(
        &'life0 self,
        prefix: Option<&'prefix str>,
        tags: Option<Vec<String>>,
        summary: Option<bool>,
        static_data_only: Option<bool>,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<EnrichedRuleDto>, Error<GetRulesError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'prefix: 'async_trait,
             'tags: 'async_trait,
             'summary: 'async_trait,
             'static_data_only: 'async_trait,
             'life0: 'async_trait;
    fn get_schedule_rule_simulations<'from, 'until, 'life0, 'async_trait>(
        &'life0 self,
        from: Option<&'from str>,
        until: Option<&'until str>,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<RuleExecution>, Error<GetScheduleRuleSimulationsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'from: 'async_trait,
             'until: 'async_trait,
             'life0: 'async_trait;
    fn run_rule_now1<'rule_uid, 'request_body, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
        request_body: Option<HashMap<String, Value>>,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<RunRuleNow1Error>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'request_body: 'async_trait,
             'life0: 'async_trait;
    fn set_rule_module_config_parameter<'rule_uid, 'module_category, 'id, 'param, 'body, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
        module_category: &'module_category str,
        id: &'id str,
        param: &'param str,
        body: &'body str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<SetRuleModuleConfigParameterError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'module_category: 'async_trait,
             'id: 'async_trait,
             'param: 'async_trait,
             'body: 'async_trait,
             'life0: 'async_trait;
    fn update_rule<'rule_uid, 'rule_dto, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
        rule_dto: RuleDto,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<UpdateRuleError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'rule_dto: 'async_trait,
             'life0: 'async_trait;
    fn update_rule_configuration<'rule_uid, 'request_body, 'life0, 'async_trait>(
        &'life0 self,
        rule_uid: &'rule_uid str,
        request_body: Option<HashMap<String, Value>>,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<UpdateRuleConfigurationError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'rule_uid: 'async_trait,
             'request_body: 'async_trait,
             'life0: 'async_trait;

}
Available on crate feature rules_api only.

Required Methods§

Source

fn create_rule<'rule_dto, 'life0, 'async_trait>( &'life0 self, rule_dto: RuleDto, ) -> Pin<Box<dyn Future<Output = Result<(), Error<CreateRuleError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_dto: 'async_trait, 'life0: 'async_trait,

POST /rules

Source

fn delete_rule<'rule_uid, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, ) -> Pin<Box<dyn Future<Output = Result<(), Error<DeleteRuleError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'life0: 'async_trait,

DELETE /rules/{ruleUID}

Source

fn enable_rule<'rule_uid, 'body, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, body: &'body str, ) -> Pin<Box<dyn Future<Output = Result<(), Error<EnableRuleError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'body: 'async_trait, 'life0: 'async_trait,

POST /rules/{ruleUID}/enable

Source

fn get_rule_actions<'rule_uid, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, ) -> Pin<Box<dyn Future<Output = Result<Vec<ActionDto>, Error<GetRuleActionsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'life0: 'async_trait,

GET /rules/{ruleUID}/actions

Source

fn get_rule_by_id<'rule_uid, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, ) -> Pin<Box<dyn Future<Output = Result<EnrichedRuleDto, Error<GetRuleByIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'life0: 'async_trait,

GET /rules/{ruleUID}

Source

fn get_rule_conditions<'rule_uid, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, ) -> Pin<Box<dyn Future<Output = Result<Vec<ConditionDto>, Error<GetRuleConditionsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'life0: 'async_trait,

GET /rules/{ruleUID}/conditions

Source

fn get_rule_configuration<'rule_uid, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, ) -> Pin<Box<dyn Future<Output = Result<String, Error<GetRuleConfigurationError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'life0: 'async_trait,

GET /rules/{ruleUID}/config

Source

fn get_rule_module_by_id<'rule_uid, 'module_category, 'id, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, module_category: &'module_category str, id: &'id str, ) -> Pin<Box<dyn Future<Output = Result<ModuleDto, Error<GetRuleModuleByIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'module_category: 'async_trait, 'id: 'async_trait, 'life0: 'async_trait,

GET /rules/{ruleUID}/{moduleCategory}/{id}

Source

fn get_rule_module_config<'rule_uid, 'module_category, 'id, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, module_category: &'module_category str, id: &'id str, ) -> Pin<Box<dyn Future<Output = Result<String, Error<GetRuleModuleConfigError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'module_category: 'async_trait, 'id: 'async_trait, 'life0: 'async_trait,

GET /rules/{ruleUID}/{moduleCategory}/{id}/config

Source

fn get_rule_module_config_parameter<'rule_uid, 'module_category, 'id, 'param, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, module_category: &'module_category str, id: &'id str, param: &'param str, ) -> Pin<Box<dyn Future<Output = Result<String, Error<GetRuleModuleConfigParameterError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'module_category: 'async_trait, 'id: 'async_trait, 'param: 'async_trait, 'life0: 'async_trait,

GET /rules/{ruleUID}/{moduleCategory}/{id}/config/{param}

Source

fn get_rule_triggers<'rule_uid, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, ) -> Pin<Box<dyn Future<Output = Result<Vec<TriggerDto>, Error<GetRuleTriggersError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'life0: 'async_trait,

GET /rules/{ruleUID}/triggers

Source

fn get_rules<'prefix, 'tags, 'summary, 'static_data_only, 'life0, 'async_trait>( &'life0 self, prefix: Option<&'prefix str>, tags: Option<Vec<String>>, summary: Option<bool>, static_data_only: Option<bool>, ) -> Pin<Box<dyn Future<Output = Result<Vec<EnrichedRuleDto>, Error<GetRulesError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'prefix: 'async_trait, 'tags: 'async_trait, 'summary: 'async_trait, 'static_data_only: 'async_trait, 'life0: 'async_trait,

GET /rules

Source

fn get_schedule_rule_simulations<'from, 'until, 'life0, 'async_trait>( &'life0 self, from: Option<&'from str>, until: Option<&'until str>, ) -> Pin<Box<dyn Future<Output = Result<Vec<RuleExecution>, Error<GetScheduleRuleSimulationsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'from: 'async_trait, 'until: 'async_trait, 'life0: 'async_trait,

GET /rules/schedule/simulations

Source

fn run_rule_now1<'rule_uid, 'request_body, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, request_body: Option<HashMap<String, Value>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error<RunRuleNow1Error>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'request_body: 'async_trait, 'life0: 'async_trait,

POST /rules/{ruleUID}/runnow

Source

fn set_rule_module_config_parameter<'rule_uid, 'module_category, 'id, 'param, 'body, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, module_category: &'module_category str, id: &'id str, param: &'param str, body: &'body str, ) -> Pin<Box<dyn Future<Output = Result<(), Error<SetRuleModuleConfigParameterError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'module_category: 'async_trait, 'id: 'async_trait, 'param: 'async_trait, 'body: 'async_trait, 'life0: 'async_trait,

PUT /rules/{ruleUID}/{moduleCategory}/{id}/config/{param}

Source

fn update_rule<'rule_uid, 'rule_dto, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, rule_dto: RuleDto, ) -> Pin<Box<dyn Future<Output = Result<(), Error<UpdateRuleError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'rule_dto: 'async_trait, 'life0: 'async_trait,

PUT /rules/{ruleUID}

Source

fn update_rule_configuration<'rule_uid, 'request_body, 'life0, 'async_trait>( &'life0 self, rule_uid: &'rule_uid str, request_body: Option<HashMap<String, Value>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error<UpdateRuleConfigurationError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'rule_uid: 'async_trait, 'request_body: 'async_trait, 'life0: 'async_trait,

PUT /rules/{ruleUID}/config

Implementors§