docs/ONAP Model Spec/im/VES/VES-datatype.rst


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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319

.. Copyright 2019
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode

VES Datatype Definition
-----------------------

.. contents::
   :depth: 3
..

ArrayOfSchemaObject datatype
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Ves::TypeDefinitions::ArrayOfSchemaObject

**Description:**

arrayOfSchemaObject - The arrayOfSchemaObject datatype provides an array of json objects, each of which is described by name, schema and other meta-information.

Note: The VES Spec has this as a Json based object.

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type ArrayOfSchemaObject**

=================== ============ ========= ============================================================================================================================================================= ==================================
**Attribute Name**  **Type**     **Mult.** **Description**                                                                                                                                               **Stereotypes**
=================== ============ ========= ============================================================================================================================================================= ==================================
arrayOfSchemaObject SchemaObject 1..\*     arrayOfSchemaObject - arrayOfSchemaObject datatype provides an array of SchemaObjects, each of which is described by name, schema and other meta-information. OpenModelAttribute
                                                                                                                                                                                                        
                                                                                                                                                                                                         -  isInvariant: false
                                                                                                                                                                                                        
                                                                                                                                                                                                         -  valueRange: no range constraint
                                                                                                                                                                                                        
                                                                                                                                                                                                         -  support: MANDATORY
                                                                                                                                                                                                        
                                                                                                                                                                                                         Preliminary
=================== ============ ========= ============================================================================================================================================================= ==================================

ArrayofNamedHashMap datatype
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Ves::TypeDefinitions::ArrayofNamedHashMap

**Description:**

Array of named hashMaps

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type ArrayofNamedHashMap**

=================== ============ ========= ======================= ==================================
**Attribute Name**  **Type**     **Mult.** **Description**         **Stereotypes**
=================== ============ ========= ======================= ==================================
arrayOfNamedHashmap NamedHashMap 1..\*     Array of named hashMaps OpenModelAttribute
                                                                  
                                                                   -  isInvariant: false
                                                                  
                                                                   -  valueRange: no range constraint
                                                                  
                                                                   -  support: MANDATORY
                                                                  
                                                                   Preliminary
=================== ============ ========= ======================= ==================================

HashMap datatype
^^^^^^^^^^^^^^^^

**Qualified Name:** Ves::TypeDefinitions::HashMap

**Description:**

The hashMap datatype is an 'associative array', which is an unordered collection of key-value pairs of the form "key": "value", where each key and value are strings. Keys must use camel casing to separate words and acronyms; only the first letter of each acronym shall be capitalized.

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type HashMap**

================== ============ ========= ======================================================== ==================================
**Attribute Name** **Type**     **Mult.** **Description**                                          **Stereotypes**
================== ============ ========= ======================================================== ==================================
hashmapEntry       KeyValuePair 0..\*     A given entry in the hashmap, which is a key/value pair. OpenModelAttribute
                                                                                                  
                                                                                                   -  isInvariant: false
                                                                                                  
                                                                                                   -  valueRange: no range constraint
                                                                                                  
                                                                                                   -  support: MANDATORY
                                                                                                  
                                                                                                   Preliminary
================== ============ ========= ======================================================== ==================================

NamedHashMap datatype
^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Ves::TypeDefinitions::NamedHashMap

**Description:**

namedHashMap [ ] - The namedHashmap datatype is a hashMap which is associated with and described by a name.

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type NamedHashMap**

================== ======== ========= =========================================================================== ==================================
**Attribute Name** **Type** **Mult.** **Description**                                                             **Stereotypes**
================== ======== ========= =========================================================================== ==================================
name               String   1         name - Name for the array of name-value pairs.                              OpenModelAttribute
                                                                                                                 
                                                                                                                  -  isInvariant: false
                                                                                                                 
                                                                                                                  -  valueRange: no range constraint
                                                                                                                 
                                                                                                                  -  support: MANDATORY
                                                                                                                 
                                                                                                                  Preliminary
hashMap            HashMap  1         hashMap - One or more key:value pairs.                                      OpenModelAttribute
                                      Note: in ATTServiceSpecification - VesEventListener v5.4.1 type = field [].
                                                                                                                  -  isInvariant: false
                                                                                                                 
                                                                                                                  -  valueRange: no range constraint
                                                                                                                 
                                                                                                                  -  support: MANDATORY
                                                                                                                 
                                                                                                                  Preliminary
================== ======== ========= =========================================================================== ==================================

ProcessStats datatype
^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Ves::TypeDefinitions::ProcessStats

SchemaObject datatype
^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Ves::TypeDefinitions::SchemaObject

**Description:**

SchemaObject - The SchemaObject datatype provides an object schema, name and other meta-information along with one or more object instances that conform to the schema.

Note: The VES Spec has this as a Json based object.

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type SchemaObject**

===================== ==================== ========= ============================================================================================================================================================================================= ==================================
**Attribute Name**    **Type**             **Mult.** **Description**                                                                                                                                                                               **Stereotypes**
===================== ==================== ========= ============================================================================================================================================================================================= ==================================
objectInstances       SchemaObjectInstance 1..\*     objectInstances - Contains one or more instances of the SchemaObjectInstance object.                                                                                                          OpenModelAttribute
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  isInvariant: false
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  valueRange: no range constraint
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  support: MANDATORY
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   Preliminary
objectName            String               1         objectName - Name of the object.                                                                                                                                                              OpenModelAttribute
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  isInvariant: false
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  valueRange: no range constraint
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  support: MANDATORY
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   Preliminary
objectSchema          String               0..1      objectSchema - schema for the object.                                                                                                                                                         OpenModelAttribute
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  isInvariant: false
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  valueRange: no range constraint
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  support: MANDATORY
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   Preliminary
objectSchemaUrl       String               0..1      objectSchemaUrl - URL to the schema for the object.                                                                                                                                           OpenModelAttribute
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  isInvariant: false
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  valueRange: no range constraint
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  support: MANDATORY
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   Preliminary
nfSubcribedObjectName String               0..1      nfSubscribedObjectName - Name of the object associated with the nfSubscriptionId.                                                                                                             OpenModelAttribute
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  isInvariant: false
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  valueRange: no range constraint
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  support: MANDATORY
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   Preliminary
nfSubcriptionId       String               0..1      nfSubscriptionId - Identifies an OpenConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the SchemaObject. OpenModelAttribute
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  isInvariant: false
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  valueRange: no range constraint
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   -  support: MANDATORY
                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                   Preliminary
===================== ==================== ========= ============================================================================================================================================================================================= ==================================

SchemaObjectInstance datatype
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Ves::TypeDefinitions::SchemaObjectInstance

**Description:**

SchemaObjectInstance [ ] - The SchemabjectInstance datatype provides meta-information about an instance of a SchemaObject along with the actual object instance.

Note: The VES Spec has this as a Json based object.

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type SchemaObjectInstance**

=========================== ============ ========= ====================================================================================================================================================================== ==================================
**Attribute Name**          **Type**     **Mult.** **Description**                                                                                                                                                        **Stereotypes**
=========================== ============ ========= ====================================================================================================================================================================== ==================================
schemaObject                SchemaObject 0..\*     SchemaObject - Optional recursive specification on SchemaObject                                                                                                        OpenModelAttribute
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  isInvariant: false
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  valueRange: no range constraint
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  support: MANDATORY
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          Preliminary
objectInstance              Object       0..1      objectInstance - Contains an instance conforming to the SchemaObject schema                                                                                            OpenModelAttribute
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  isInvariant: false
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  valueRange: no range constraint
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  support: MANDATORY
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          Preliminary
objectInstanceEpochMicrosec UnixEpoch    0..1      objectInstanceEpochMicrosec - the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds. OpenModelAttribute
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  isInvariant: false
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  valueRange: no range constraint
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  support: MANDATORY
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          Preliminary
objectKeys                  Key          0..\*     objectKeys - An ordered set of keys that identifies this particular instance of SchemaObject (e.g., that places it in a hierarchy).                                    OpenModelAttribute
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  isInvariant: false
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  valueRange: no range constraint
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          -  support: MANDATORY
                                                                                                                                                                                                                         
                                                                                                                                                                                                                          Preliminary
=========================== ============ ========= ====================================================================================================================================================================== ==================================

ThresholdCrossingAlertCounter datatype
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Ves::TypeDefinitions::ThresholdCrossingAlertCounter

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type ThresholdCrossingAlertCounter**

================== ============== ========= ============================================================================ ==================================
**Attribute Name** **Type**       **Mult.** **Description**                                                              **Stereotypes**
================== ============== ========= ============================================================================ ==================================
criticality        TCACriticality 1         Enumeration: 'CRIT', 'MAJ'                                                   OpenModelAttribute
                                                                                                                        
                                                                                                                         -  isInvariant: false
                                                                                                                        
                                                                                                                         -  valueRange: no range constraint
                                                                                                                        
                                                                                                                         -  support: MANDATORY
                                                                                                                        
                                                                                                                         Preliminary
hashMap            HashMap        1         Key is the name of the counter and value is the current value of the counter OpenModelAttribute
                                                                                                                        
                                                                                                                         -  isInvariant: false
                                                                                                                        
                                                                                                                         -  valueRange: no range constraint
                                                                                                                        
                                                                                                                         -  support: MANDATORY
                                                                                                                        
                                                                                                                         Preliminary
thresholdCrossed   String         1         Last threshold that was crossed                                              OpenModelAttribute
                                                                                                                        
                                                                                                                         -  isInvariant: false
                                                                                                                        
                                                                                                                         -  valueRange: no range constraint
                                                                                                                        
                                                                                                                         -  support: MANDATORY
                                                                                                                        
                                                                                                                         Preliminary
================== ============== ========= ============================================================================ ==================================