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