VES Datatype Definition
Data Types
ArrayOfSchemaObject
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
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
arrayOfSchemaObject |
SchemaObject |
1..* |
RW |
Preliminary OpenModelAttribute
|
arrayOfSchemaObject - arrayOfSchemaObject datatype provides an array of SchemaObjects, each of which is described by name, schema and other meta-information. |
ArrayofNamedHashMap
Array of named hashMaps
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
arrayOfNamedHashmap |
NamedHashMap |
1..* |
RW |
Preliminary OpenModelAttribute
|
Array of named hashMaps |
AttributeList
Applied stereotypes:
Experimental
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
atributeName |
String |
1 |
RW |
OpenModelAttribute
|
|
newAttributeValue |
String |
1 |
RW |
OpenModelAttribute
|
|
NewAttributeType |
String |
1 |
RW |
OpenModelAttribute
|
|
oldAttributeValue |
String |
1 |
RW |
OpenModelAttribute
|
|
oldAttributeType |
String |
1 |
RW |
OpenModelAttribute
|
HashMap
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
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
hashmapEntry |
KeyValuePair |
0..* |
RW |
Preliminary OpenModelAttribute
|
A given entry in the hashmap, which is a key/value pair. |
NamedHashMap
namedHashMap [ ] - The namedHashmap datatype is a hashMap which is associated with and described by a name.
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
name |
String |
1 |
RW |
Preliminary OpenModelAttribute
|
name - Name for the array of name-value pairs. |
hashMap |
HashMap |
1 |
RW |
Preliminary OpenModelAttribute
|
hashMap - One or more key:value pairs. Note: in ATTServiceSpecification - VesEventListener v5.4.1 type = field []. |
ProcessStats
Applied stereotypes:
SchemaObject
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
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
objectInstances |
SchemaObjectInstance |
1..* |
RW |
Preliminary OpenModelAttribute
|
objectInstances - Contains one or more instances of the SchemaObjectInstance object. |
objectName |
String |
1 |
RW |
Preliminary OpenModelAttribute
|
objectName - Name of the object. |
objectSchema |
String |
0..1 |
RW |
Preliminary OpenModelAttribute
|
objectSchema - schema for the object. |
objectSchemaUrl |
String |
0..1 |
RW |
Preliminary OpenModelAttribute
|
objectSchemaUrl - URL to the schema for the object. |
nfSubcribedObjectName |
String |
0..1 |
RW |
Preliminary OpenModelAttribute
|
nfSubscribedObjectName - Name of the object associated with the nfSubscriptionId. |
nfSubcriptionId |
String |
0..1 |
RW |
Preliminary OpenModelAttribute
|
nfSubscriptionId - Identifies an OpenConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the SchemaObject. |
SchemaObjectInstance
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
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
schemaObject |
SchemaObject |
0..* |
RW |
Preliminary OpenModelAttribute
|
SchemaObject - Optional recursive specification on SchemaObject |
objectInstance |
Object |
0..1 |
RW |
Preliminary OpenModelAttribute
|
objectInstance - Contains an instance conforming to the SchemaObject schema |
objectInstanceEpochMicrosec |
UnixEpoch |
0..1 |
RW |
Preliminary OpenModelAttribute
|
objectInstanceEpochMicrosec - the unix time, aka epoch time, associated with this objectInstance–as microseconds elapsed since 1 Jan 1970 not including leap seconds. |
objectKeys |
Key |
0..* |
RW |
Preliminary OpenModelAttribute
|
objectKeys - An ordered set of keys that identifies this particular instance of SchemaObject (e.g., that places it in a hierarchy). |
ThresholdCrossingAlertCounter
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
criticality |
TCACriticality |
1 |
RW |
Preliminary OpenModelAttribute
|
Enumeration: ‘CRIT’, ‘MAJ’ |
hashMap |
HashMap |
1 |
RW |
Preliminary OpenModelAttribute
|
Key is the name of the counter and value is the current value of the counter |
thresholdCrossed |
String |
1 |
RW |
Preliminary OpenModelAttribute
|
Last threshold that was crossed |