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