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