9f7acde93ad6555bf59582d7a1bc888978727241
[aquarium] / src / main / avro / aquarium-policy.avdl
1 /*
2  * Copyright 2011-2012 GRNET S.A. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or
5  * without modification, are permitted provided that the following
6  * conditions are met:
7  *
8  *   1. Redistributions of source code must retain the above
9  *      copyright notice, this list of conditions and the following
10  *      disclaimer.
11  *
12  *   2. Redistributions in binary form must reproduce the above
13  *      copyright notice, this list of conditions and the following
14  *      disclaimer in the documentation and/or other materials
15  *      provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * The views and conclusions contained in the software and
31  * documentation are those of the authors and should not be
32  * interpreted as representing official policies, either expressed
33  * or implied, of GRNET S.A.
34  */
35
36 @namespace("gr.grnet.aquarium.message.avro.gen")
37 protocol AquariumPolicy {
38   record ResourceTypeMsg {
39     string name; // name of resource type
40     string unit; // name of the charging unit
41     string chargingBehaviorClass; // the charging behavior implementation
42   }
43
44   record CronSpecTupleMsg {
45     string a;
46     string b;
47   }
48
49   record EffectiveUnitPriceMsg {
50     double unitPrice; // credits per unit (see ResourceTypeMsg.unit)
51     union {CronSpecTupleMsg, null} when;
52   }
53
54   record EffectivePriceTableMsg {
55     array<EffectiveUnitPriceMsg> priceOverrides;
56   }
57
58   record SelectorValueMsg {
59     union {
60       EffectivePriceTableMsg,
61       map<SelectorValueMsg>
62     } selectorValue;
63   }
64
65   record FullPriceTableMsg {
66     map<map<SelectorValueMsg>> perResource;
67   }
68
69   record PolicyMsg {
70     string originalID; // From message creator (e.g. this is present for the default policy.json)
71     union {string, null} inStoreID; // From Aquarium (message recipient)
72     union {string, null} parentID; // FIXME: parentOriginalID and parentInStoreID
73     long validFromMillis;
74     long validToMillis;
75     array<ResourceTypeMsg> resourceTypes; // the known resource types
76     array<string> chargingBehaviors;      // the known charging behavior implementations
77     map<FullPriceTableMsg> roleMapping;   // the pricing "plan" per role
78   }
79 }