docs/api/policytypes/onap.policies.controlloop.guard.FrequencyLimiter.json

   1 {
   2    "tosca_definitions_version": "tosca_simple_yaml_1_0_0",
   3    "policy_types": [
   4       {
   5          "onap.policies.controlloop.Guard": {
   6             "derived_from": "tosca.policies.Root",
   7             "version": "1.0.0",
   8             "description": "Guard Policies for Control Loop Operational Policies"
   9          }
  10       },
  11       {
  12          "onap.policies.controlloop.guard.FrequencyLimiter": {
  13             "derived_from": "onap.policies.controlloop.Guard",
  14             "version": "1.0.0",
  15             "description": "Supports limiting the frequency of actions being taken by a Actor.",
  16             "properties": {
  17                "frequency_policy": {
  18                   "type": "map",
  19                   "description": null,
  20                   "entry_schema": {
  21                      "type": "onap.datatypes.guard.FrequencyLimiter"
  22                   }
  23                }
  24             }
  25          }
  26       }
  27    ],
  28    "data_types": [
  29       {
  30          "onap.datatypes.guard.FrequencyLimiter": {
  31             "derived_from": "tosca.datatypes.Root",
  32             "properties": {
  33                "actor": {
  34                   "type": "string",
  35                   "description": "Specifies the Actor",
  36                   "required": true
  37                },
  38                "recipe": {
  39                   "type": "string",
  40                   "description": "Specified the Recipe",
  41                   "required": true
  42                },
  43                "time_window": {
  44                   "type": "scalar-unit.time",
  45                   "description": "The time window to count the actions against.",
  46                   "required": true
  47                },
  48                "limit": {
  49                   "type": "integer",
  50                   "description": "The limit",
  51                   "required": true,
  52                   "constraints": [
  53                      {
  54                         "greater_than": 0
  55                      }
  56                   ]
  57                },
  58                "time_range": {
  59                   "type": "tosca.datatypes.TimeInterval",
  60                   "description": "An optional range of time during the day the frequency is valid for.",
  61                   "required": false
  62                },
  63                "controlLoopName": {
  64                   "type": "string",
  65                   "description": "An optional specific control loop to apply this guard to.",
  66                   "required": false
  67                },
  68                "target": {
  69                   "type": "string",
  70                   "description": "An optional specific VNF to apply this guard to.",
  71                   "required": false
  72                }
  73             }
  74          }
  75       }
  76    ]
  77 }