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