catalog-be/src/main/resources/import/tosca/models/init/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   properties:
 153     DN:
 154       name: DN
 155       type: string
 156       typeVersion: 0.0.0
 157       description: Managed object distinguished name
 158       required: true
 159   name: onap.datatypes.monitoring.managedObjectDNsBasic
 160   version: 0.0.0
 161   derived_from: tosca.datatypes.Root
 162 onap.datatypes.monitoring.managedObjectDNsBasics:
 163   properties:
 164     managedObjectDNsBasic:
 165       name: managedObjectDNsBasic
 166       type: map
 167       typeVersion: 0.0.0
 168       description: Managed object distinguished name object
 169       required: true
 170       entry_schema:
 171         type: onap.datatypes.monitoring.managedObjectDNsBasic
 172         typeVersion: 0.0.0
 173   name: onap.datatypes.monitoring.managedObjectDNsBasics
 174   version: 0.0.0
 175   derived_from: tosca.datatypes.Root
 176 onap.datatypes.monitoring.measurementGroup:
 177   properties:
 178     measurementTypes:
 179       name: measurementTypes
 180       type: list
 181       typeVersion: 0.0.0
 182       description: List of measurement types
 183       required: true
 184       entry_schema:
 185         type: onap.datatypes.monitoring.measurementTypes
 186         typeVersion: 0.0.0
 187     managedObjectDNsBasic:
 188       name: managedObjectDNsBasic
 189       type: list
 190       typeVersion: 0.0.0
 191       description: List of managed object distinguished names
 192       required: true
 193       entry_schema:
 194         type: onap.datatypes.monitoring.managedObjectDNsBasics
 195         typeVersion: 0.0.0
 196   name: onap.datatypes.monitoring.measurementGroup
 197   version: 0.0.0
 198   derived_from: tosca.datatypes.Root
 199 onap.datatypes.monitoring.measurementGroups:
 200   properties:
 201     measurementGroup:
 202       name: measurementGroup
 203       type: map
 204       typeVersion: 0.0.0
 205       description: Measurement Group
 206       required: true
 207       entry_schema:
 208         type: onap.datatypes.monitoring.measurementGroup
 209         typeVersion: 0.0.0
 210   name: onap.datatypes.monitoring.measurementGroups
 211   version: 0.0.0
 212   derived_from: tosca.datatypes.Root
 213 onap.datatypes.monitoring.measurementType:
 214   properties:
 215     measurementType:
 216       name: measurementType
 217       type: string
 218       typeVersion: 0.0.0
 219       description: Measurement type
 220       required: true
 221   name: onap.datatypes.monitoring.measurementType
 222   version: 0.0.0
 223   derived_from: tosca.datatypes.Root
 224 onap.datatypes.monitoring.measurementTypes:
 225   properties:
 226     measurementType:
 227       name: measurementType
 228       type: map
 229       typeVersion: 0.0.0
 230       description: Measurement type object
 231       required: true
 232       entry_schema:
 233         type: onap.datatypes.monitoring.measurementType
 234         typeVersion: 0.0.0
 235   name: onap.datatypes.monitoring.measurementTypes
 236   version: 0.0.0
 237   derived_from: tosca.datatypes.Root
 238 onap.datatypes.monitoring.nfFilter:
 239   properties:
 240     modelNames:
 241       name: modelNames
 242       type: list
 243       typeVersion: 0.0.0
 244       description: List of model names
 245       required: true
 246       entry_schema:
 247         type: string
 248         typeVersion: 0.0.0
 249     modelInvariantIDs:
 250       name: modelInvariantIDs
 251       type: list
 252       typeVersion: 0.0.0
 253       description: List of model invariant IDs
 254       required: true
 255       entry_schema:
 256         type: string
 257         typeVersion: 0.0.0
 258     modelVersionIDs:
 259       name: modelVersionIDs
 260       type: list
 261       typeVersion: 0.0.0
 262       description: List of model version IDs
 263       required: true
 264       entry_schema:
 265         type: string
 266         typeVersion: 0.0.0
 267     nfNames:
 268       name: nfNames
 269       type: list
 270       typeVersion: 0.0.0
 271       description: List of network functions
 272       required: true
 273       entry_schema:
 274         type: string
 275         typeVersion: 0.0.0
 276   name: onap.datatypes.monitoring.nfFilter
 277   version: 0.0.0
 278   derived_from: tosca.datatypes.Root
 279 onap.datatypes.monitoring.subscription:
 280   properties:
 281     measurementGroups:
 282       name: measurementGroups
 283       type: list
 284       typeVersion: 0.0.0
 285       description: Measurement Groups
 286       required: true
 287       entry_schema:
 288         type: onap.datatypes.monitoring.measurementGroups
 289         typeVersion: 0.0.0
 290     fileBasedGP:
 291       name: fileBasedGP
 292       type: integer
 293       typeVersion: 0.0.0
 294       description: File based granularity period
 295       required: true
 296     fileLocation:
 297       name: fileLocation
 298       type: string
 299       typeVersion: 0.0.0
 300       description: ROP file location
 301       required: true
 302     subscriptionName:
 303       name: subscriptionName
 304       type: string
 305       typeVersion: 0.0.0
 306       description: Name of the subscription
 307       required: true
 308     administrativeState:
 309       name: administrativeState
 310       type: string
 311       typeVersion: 0.0.0
 312       description: State of the subscription
 313       required: true
 314       constraints:
 315         - valid_values:
 316             - LOCKED
 317             - UNLOCKED
 318     nfFilter:
 319       name: nfFilter
 320       type: map
 321       typeVersion: 0.0.0
 322       description: Network function filter
 323       required: true
 324       entry_schema:
 325         type: onap.datatypes.monitoring.nfFilter
 326         typeVersion: 0.0.0
 327   name: onap.datatypes.monitoring.subscription
 328   version: 0.0.0
 329   derived_from: tosca.datatypes.Root
 330 org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest:
 331   version: 1.0.0
 332   derived_from: tosca.datatypes.Root
 333   properties:
 334     restRequestId:
 335       type: onap.datatypes.ToscaConceptIdentifier
 336       typeVersion: 1.0.0
 337       required: true
 338       description: The name and version of a REST request to be sent to a REST endpoint
 339     httpMethod:
 340       type: string
 341       required: true
 342       constraints:
 343         - valid_values:
 344             - POST
 345             - PUT
 346             - GET
 347             - DELETE
 348       description: The REST method to use
 349     path:
 350       type: string
 351       required: true
 352       description: The path of the REST request relative to the base URL
 353     body:
 354       type: string
 355       required: false
 356       description: The body of the REST request for PUT and POST requests
 357     expectedResponse:
 358       type: integer
 359       required: true
 360       description: THe expected HTTP status code for the REST request
 361 org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity:
 362   version: 1.0.0
 363   derived_from: tosca.datatypes.Root
 364   properties:
 365     configurationEntityId:
 366       type: onap.datatypes.ToscaConceptIdentifier
 367       typeVersion: 1.0.0
 368       required: true
 369       description: The name and version of a Configuration Entity to be handled by the HTTP
 370         Automation Composition Element
 371     restSequence:
 372       type: list
 373       entry_schema:
 374         type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest
 375         typeVersion: 1.0.0
 376       description: A sequence of REST commands to send to the REST endpoint