45e5471fc1b6bb46ca4222c123de2d71a6c0cb06
[policy/models.git] / models-examples / src / main / resources / policytypes / onap.policies.controlloop.guard.FrequencyLimiter.yaml
1 tosca_definitions_version: tosca_simple_yaml_1_0_0
2 policy_types:
3    onap.policies.controlloop.Guard:
4       derived_from: tosca.policies.Root
5       version: 1.0.0
6       description: Guard Policies for Control Loop Operational Policies
7    onap.policies.controlloop.guard.FrequencyLimiter:
8       derived_from: onap.policies.controlloop.Guard
9       version: 1.0.0
10       description: Supports limiting the frequency of actions being taken by a Actor.
11       properties:
12          frequency_policy:
13             type: map
14             description: null
15             entry_schema:
16                type: onap.datatypes.guard.FrequencyLimiter
17 data_types:
18    onap.datatypes.guard.FrequencyLimiter:
19       derived_from: tosca.datatypes.Root
20       properties:
21          actor:
22             type: string
23             description: Specifies the Actor
24             required: true
25          recipe:
26             type: string
27             description: Specified the Recipe
28             required: true
29          time_window:
30             type: scalar-unit.time
31             description: The time window to count the actions against.
32             required: true
33          limit:
34             type: integer
35             description: The limit
36             required: true
37             constraints:
38             -  greater_than: 0
39          time_range:
40             type: tosca.datatypes.TimeInterval
41             description: An optional range of time during the day the frequency is valid for.
42             required: false
43          controlLoopName:
44             type: string
45             description: An optional specific control loop to apply this guard to.
46             required: false
47          target:
48             type: string
49             description: An optional specific VNF to apply this guard to.
50             required: false