catalog-be/src/main/resources/import/tosca/models/init/controlloop/tosca/data-types/dataTypes.yml

   1 tosca.datatypes.Root:
   2   description: The TOSCA root Data Type all other TOSCA base Data Types derive from
   3 integer:
   4   derived_from: tosca.datatypes.Root
   5 string:
   6   derived_from: tosca.datatypes.Root
   7 boolean:
   8   derived_from: tosca.datatypes.Root
   9 float:
  10   derived_from: tosca.datatypes.Root
  11 list:
  12   derived_from: tosca.datatypes.Root
  13 map:
  14   derived_from: tosca.datatypes.Root
  15 json:
  16   derived_from: tosca.datatypes.Root
  17 scalar-unit:
  18   derived_from: tosca.datatypes.Root
  19 scalar-unit.size:
  20   derived_from: scalar-unit
  21 scalar-unit.time:
  22   derived_from: scalar-unit
  23 scalar-unit.frequency:
  24   derived_from: scalar-unit
  25 onap.datatypes.ToscaConceptIdentifier:
  26   derived_from: tosca.datatypes.Root
  27   properties:
  28     name:
  29       type: string
  30       required: true
  31     version:
  32       type: string
  33       required: true
  34 onap.datatype.controlloop.Target:
  35   derived_from: tosca.datatypes.Root
  36   description: Definition for a entity in A&AI to perform a control loop operation on
  37   properties:
  38     targetType:
  39       type: string
  40       description: Category for the target type
  41       required: true
  42       constraints:
  43         - valid_values:
  44             - VNF
  45             - VM
  46             - VFMODULE
  47             - PNF
  48     entityIds:
  49       type: map
  50       description: Map of values that identify the resource. If none are provided, it is
  51         assumed that the entity that generated the ONSET event will be the target.
  52       required: false
  53       metadata:
  54         clamp_possible_values: 'ClampExecution:CSAR_RESOURCES'
  55       entry_schema:
  56         type: string
  57 onap.datatype.controlloop.Actor:
  58   derived_from: tosca.datatypes.Root
  59   description: An actor/operation/target definition
  60   properties:
  61     actor:
  62       type: string
  63       description: The actor performing the operation.
  64       required: true
  65       metadata:
  66         clamp_possible_values: 'Dictionary:DefaultActors,ClampExecution:CDS/actor'
  67     operation:
  68       type: string
  69       description: The operation the actor is performing.
  70       metadata:
  71         clamp_possible_values: 'Dictionary:DefaultOperations,ClampExecution:CDS/operation'
  72       required: true
  73     target:
  74       type: onap.datatype.controlloop.Target
  75       description: The resource the operation should be performed on.
  76       required: true
  77     payload:
  78       type: map
  79       description: Name/value pairs of payload information passed by Policy to the actor
  80       required: false
  81       metadata:
  82         clamp_possible_values: 'ClampExecution:CDS/payload'
  83       entry_schema:
  84         type: string
  85 onap.datatype.controlloop.Operation:
  86   derived_from: tosca.datatypes.Root
  87   description: An operation supported by an actor
  88   properties:
  89     id:
  90       type: string
  91       description: Unique identifier for the operation
  92       required: true
  93     description:
  94       type: string
  95       description: A user-friendly description of the intent for the operation
  96       required: false
  97     operation:
  98       type: onap.datatype.controlloop.Actor
  99       description: The definition of the operation to be performed.
 100       required: true
 101     timeout:
 102       type: integer
 103       description: The amount of time for the actor to perform the operation.
 104       required: true
 105     retries:
 106       type: integer
 107       description: The number of retries the actor should attempt to perform the operation.
 108       required: true
 109       default: 0
 110     success:
 111       type: string
 112       description: Points to the operation to invoke on success. A value of "final_success"
 113         indicates and end to the operation.
 114       required: false
 115       default: final_success
 116     failure:
 117       type: string
 118       description: Points to the operation to invoke on Actor operation failure.
 119       required: false
 120       default: final_failure
 121     failure_timeout:
 122       type: string
 123       description: Points to the operation to invoke when the time out for the operation
 124         occurs.
 125       required: false
 126       default: final_failure_timeout
 127     failure_retries:
 128       type: string
 129       description: Points to the operation to invoke when the current operation has
 130         exceeded its max retries.
 131       required: false
 132       default: final_failure_retries
 133     failure_exception:
 134       type: string
 135       description: Points to the operation to invoke when the current operation causes an
 136         exception.
 137       required: false
 138       default: final_failure_exception
 139     failure_guard:
 140       type: string
 141       description: Points to the operation to invoke when the current operation is blocked
 142         due to guard policy enforcement.
 143       required: false
 144       default: final_failure_guard
 145 onap.datatypes.monitoring.managedObjectDNsBasic:
 146   constraints: []
 147   properties:
 148     DN:
 149       name: DN
 150       type: string
 151       typeVersion: 0.0.0
 152       description: Managed object distinguished name
 153       required: true
 154       constraints: []
 155       metadata: {}
 156   name: onap.datatypes.monitoring.managedObjectDNsBasic
 157   version: 0.0.0
 158   derived_from: tosca.datatypes.Root
 159   metadata: {}
 160 onap.datatypes.monitoring.managedObjectDNsBasics:
 161   constraints: []
 162   properties:
 163     managedObjectDNsBasic:
 164       name: managedObjectDNsBasic
 165       type: map
 166       typeVersion: 0.0.0
 167       description: Managed object distinguished name object
 168       required: true
 169       constraints: []
 170       entry_schema:
 171         type: onap.datatypes.monitoring.managedObjectDNsBasic
 172         typeVersion: 0.0.0
 173         constraints: []
 174       metadata: {}
 175   name: onap.datatypes.monitoring.managedObjectDNsBasics
 176   version: 0.0.0
 177   derived_from: tosca.datatypes.Root
 178   metadata: {}
 179 onap.datatypes.monitoring.measurementGroup:
 180   constraints: []
 181   properties:
 182     measurementTypes:
 183       name: measurementTypes
 184       type: list
 185       typeVersion: 0.0.0
 186       description: List of measurement types
 187       required: true
 188       constraints: []
 189       entry_schema:
 190         type: onap.datatypes.monitoring.measurementTypes
 191         typeVersion: 0.0.0
 192         constraints: []
 193       metadata: {}
 194     managedObjectDNsBasic:
 195       name: managedObjectDNsBasic
 196       type: list
 197       typeVersion: 0.0.0
 198       description: List of managed object distinguished names
 199       required: true
 200       constraints: []
 201       entry_schema:
 202         type: onap.datatypes.monitoring.managedObjectDNsBasics
 203         typeVersion: 0.0.0
 204         constraints: []
 205       metadata: {}
 206   name: onap.datatypes.monitoring.measurementGroup
 207   version: 0.0.0
 208   derived_from: tosca.datatypes.Root
 209   metadata: {}
 210 onap.datatypes.monitoring.measurementGroups:
 211   constraints: []
 212   properties:
 213     measurementGroup:
 214       name: measurementGroup
 215       type: map
 216       typeVersion: 0.0.0
 217       description: Measurement Group
 218       required: true
 219       constraints: []
 220       entry_schema:
 221         type: onap.datatypes.monitoring.measurementGroup
 222         typeVersion: 0.0.0
 223         constraints: []
 224       metadata: {}
 225   name: onap.datatypes.monitoring.measurementGroups
 226   version: 0.0.0
 227   derived_from: tosca.datatypes.Root
 228   metadata: {}
 229 onap.datatypes.monitoring.measurementType:
 230   constraints: []
 231   properties:
 232     measurementType:
 233       name: measurementType
 234       type: string
 235       typeVersion: 0.0.0
 236       description: Measurement type
 237       required: true
 238       constraints: []
 239       metadata: {}
 240   name: onap.datatypes.monitoring.measurementType
 241   version: 0.0.0
 242   derived_from: tosca.datatypes.Root
 243   metadata: {}
 244 onap.datatypes.monitoring.measurementTypes:
 245   constraints: []
 246   properties:
 247     measurementType:
 248       name: measurementType
 249       type: map
 250       typeVersion: 0.0.0
 251       description: Measurement type object
 252       required: true
 253       constraints: []
 254       entry_schema:
 255         type: onap.datatypes.monitoring.measurementType
 256         typeVersion: 0.0.0
 257         constraints: []
 258       metadata: {}
 259   name: onap.datatypes.monitoring.measurementTypes
 260   version: 0.0.0
 261   derived_from: tosca.datatypes.Root
 262   metadata: {}
 263 onap.datatypes.monitoring.nfFilter:
 264   constraints: []
 265   properties:
 266     modelNames:
 267       name: modelNames
 268       type: list
 269       typeVersion: 0.0.0
 270       description: List of model names
 271       required: true
 272       constraints: []
 273       entry_schema:
 274         type: string
 275         typeVersion: 0.0.0
 276         constraints: []
 277       metadata: {}
 278     modelInvariantIDs:
 279       name: modelInvariantIDs
 280       type: list
 281       typeVersion: 0.0.0
 282       description: List of model invariant IDs
 283       required: true
 284       constraints: []
 285       entry_schema:
 286         type: string
 287         typeVersion: 0.0.0
 288         constraints: []
 289       metadata: {}
 290     modelVersionIDs:
 291       name: modelVersionIDs
 292       type: list
 293       typeVersion: 0.0.0
 294       description: List of model version IDs
 295       required: true
 296       constraints: []
 297       entry_schema:
 298         type: string
 299         typeVersion: 0.0.0
 300         constraints: []
 301       metadata: {}
 302     nfNames:
 303       name: nfNames
 304       type: list
 305       typeVersion: 0.0.0
 306       description: List of network functions
 307       required: true
 308       constraints: []
 309       entry_schema:
 310         type: string
 311         typeVersion: 0.0.0
 312         constraints: []
 313       metadata: {}
 314   name: onap.datatypes.monitoring.nfFilter
 315   version: 0.0.0
 316   derived_from: tosca.datatypes.Root
 317   metadata: {}
 318 onap.datatypes.monitoring.subscription:
 319   constraints: []
 320   properties:
 321     measurementGroups:
 322       name: measurementGroups
 323       type: list
 324       typeVersion: 0.0.0
 325       description: Measurement Groups
 326       required: true
 327       constraints: []
 328       entry_schema:
 329         type: onap.datatypes.monitoring.measurementGroups
 330         typeVersion: 0.0.0
 331         constraints: []
 332       metadata: {}
 333     fileBasedGP:
 334       name: fileBasedGP
 335       type: integer
 336       typeVersion: 0.0.0
 337       description: File based granularity period
 338       required: true
 339       constraints: []
 340       metadata: {}
 341     fileLocation:
 342       name: fileLocation
 343       type: string
 344       typeVersion: 0.0.0
 345       description: ROP file location
 346       required: true
 347       constraints: []
 348       metadata: {}
 349     subscriptionName:
 350       name: subscriptionName
 351       type: string
 352       typeVersion: 0.0.0
 353       description: Name of the subscription
 354       required: true
 355       constraints: []
 356       metadata: {}
 357     administrativeState:
 358       name: administrativeState
 359       type: string
 360       typeVersion: 0.0.0
 361       description: State of the subscription
 362       required: true
 363       constraints:
 364         - valid_values:
 365             - LOCKED
 366             - UNLOCKED
 367       metadata: {}
 368     nfFilter:
 369       name: nfFilter
 370       type: map
 371       typeVersion: 0.0.0
 372       description: Network function filter
 373       required: true
 374       constraints: []
 375       entry_schema:
 376         type: onap.datatypes.monitoring.nfFilter
 377         typeVersion: 0.0.0
 378         constraints: []
 379       metadata: {}
 380   name: onap.datatypes.monitoring.subscription
 381   version: 0.0.0
 382   derived_from: tosca.datatypes.Root
 383   metadata: {}
 384 org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest:
 385   version: 1.0.0
 386   derived_from: tosca.datatypes.Root
 387   properties:
 388     restRequestId:
 389       type: onap.datatypes.ToscaConceptIdentifier
 390       typeVersion: 1.0.0
 391       required: true
 392       description: The name and version of a REST request to be sent to a REST endpoint
 393     httpMethod:
 394       type: string
 395       required: true
 396       constraints:
 397         - valid_values:
 398             - POST
 399             - PUT
 400             - GET
 401             - DELETE
 402       description: The REST method to use
 403     path:
 404       type: string
 405       required: true
 406       description: The path of the REST request relative to the base URL
 407     body:
 408       type: string
 409       required: false
 410       description: The body of the REST request for PUT and POST requests
 411     expectedResponse:
 412       type: integer
 413       required: true
 414       constraints: []
 415       description: THe expected HTTP status code for the REST request
 416 org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity:
 417   version: 1.0.0
 418   derived_from: tosca.datatypes.Root
 419   properties:
 420     configurationEntityId:
 421       type: onap.datatypes.ToscaConceptIdentifier
 422       typeVersion: 1.0.0
 423       required: true
 424       description: The name and version of a Configuration Entity to be handled by the HTTP
 425         Control Loop Element
 426     restSequence:
 427       type: list
 428       entry_schema:
 429         type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest
 430         typeVersion: 1.0.0
 431         constraints: []
 432       description: A sequence of REST commands to send to the REST endpoint