src/test/resources/http-cache/example/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Apex/versions/1.0.0?connectionTimeToLive=5000/.file

   1 tosca_definitions_version: tosca_simple_yaml_1_1_0
   2 policy_types:
   3     onap.policies.controlloop.operational.Common:
   4         properties:
   5             abatement:
   6                 name: abatement
   7                 type: boolean
   8                 typeVersion: 0.0.0
   9                 description: Whether an abatement event message will be expected for
  10                     the control loop from DCAE.
  11                 default: 'false'
  12                 required: true
  13                 constraints: [
  14                     ]
  15                 metadata: {
  16                     }
  17             operations:
  18                 name: operations
  19                 type: list
  20                 typeVersion: 0.0.0
  21                 description: List of operations to be performed when Control Loop
  22                     is triggered.
  23                 required: true
  24                 constraints: [
  25                     ]
  26                 entry_schema:
  27                     type: onap.datatype.controlloop.Operation
  28                     typeVersion: 0.0.0
  29                     constraints: [
  30                         ]
  31                 metadata: {
  32                     }
  33             trigger:
  34                 name: trigger
  35                 type: string
  36                 typeVersion: 0.0.0
  37                 description: Initial operation to execute upon receiving an Onset
  38                     event message for the Control Loop.
  39                 required: true
  40                 constraints: [
  41                     ]
  42                 metadata: {
  43                     }
  44             timeout:
  45                 name: timeout
  46                 type: integer
  47                 typeVersion: 0.0.0
  48                 description: |
  49                     Overall timeout for executing all the operations. This timeout should equal or exceed the total
  50                     timeout for each operation listed.
  51                 required: true
  52                 constraints: [
  53                     ]
  54                 metadata: {
  55                     }
  56             id:
  57                 name: id
  58                 type: string
  59                 typeVersion: 0.0.0
  60                 description: The unique control loop id.
  61                 required: true
  62                 constraints: [
  63                     ]
  64                 metadata: {
  65                     }
  66         name: onap.policies.controlloop.operational.Common
  67         version: 1.0.0
  68         derived_from: tosca.policies.Root
  69         metadata: {
  70             }
  71         description: |
  72             Operational Policy for Control Loop execution. Originated in Frankfurt to support TOSCA Compliant
  73             Policy Types. This does NOT support the legacy Policy YAML policy type.
  74     onap.policies.controlloop.operational.common.Apex:
  75         properties:
  76             engineServiceParameters:
  77                 name: engineServiceParameters
  78                 type: string
  79                 typeVersion: 0.0.0
  80                 description: The engine parameters like name, instanceCount, policy
  81                     implementation, parameters etc.
  82                 required: true
  83                 constraints: [
  84                     ]
  85                 metadata: {
  86                     }
  87             eventOutputParameters:
  88                 name: eventOutputParameters
  89                 type: string
  90                 typeVersion: 0.0.0
  91                 description: The event output parameters.
  92                 required: true
  93                 constraints: [
  94                     ]
  95                 metadata: {
  96                     }
  97             javaProperties:
  98                 name: javaProperties
  99                 type: string
 100                 typeVersion: 0.0.0
 101                 description: Name/value pairs of properties to be set for APEX if
 102                     needed.
 103                 required: false
 104                 constraints: [
 105                     ]
 106                 metadata: {
 107                     }
 108             eventInputParameters:
 109                 name: eventInputParameters
 110                 type: string
 111                 typeVersion: 0.0.0
 112                 description: The event input parameters.
 113                 required: true
 114                 constraints: [
 115                     ]
 116                 metadata: {
 117                     }
 118         name: onap.policies.controlloop.operational.common.Apex
 119         version: 1.0.0
 120         derived_from: onap.policies.controlloop.operational.Common
 121         metadata: {
 122             }
 123         description: Operational policies for Apex PDP
 124 data_types:
 125     onap.datatype.controlloop.Actor:
 126         constraints: [
 127             ]
 128         properties:
 129             payload:
 130                 name: payload
 131                 type: map
 132                 typeVersion: 0.0.0
 133                 description: Name/value pairs of payload information passed by Policy
 134                     to the actor
 135                 required: false
 136                 constraints: [
 137                     ]
 138                 entry_schema:
 139                     type: string
 140                     typeVersion: 0.0.0
 141                     constraints: [
 142                         ]
 143                 metadata:
 144                     clamp_possible_values: ClampExecution:CDS/payload
 145             target:
 146                 name: target
 147                 type: onap.datatype.controlloop.Target
 148                 typeVersion: 0.0.0
 149                 description: The resource the operation should be performed on.
 150                 required: true
 151                 constraints: [
 152                     ]
 153                 metadata: {
 154                     }
 155             actor:
 156                 name: actor
 157                 type: string
 158                 typeVersion: 0.0.0
 159                 description: The actor performing the operation.
 160                 required: true
 161                 constraints: [
 162                     ]
 163                 metadata:
 164                     clamp_possible_values: Dictionary:DefaultActors,ClampExecution:CDS/actor
 165             operation:
 166                 name: operation
 167                 type: string
 168                 typeVersion: 0.0.0
 169                 description: The operation the actor is performing.
 170                 required: true
 171                 constraints: [
 172                     ]
 173                 metadata:
 174                     clamp_possible_values: Dictionary:DefaultOperations, ClampExecution:CDS/operation
 175         name: onap.datatype.controlloop.Actor
 176         version: 0.0.0
 177         derived_from: tosca.datatypes.Root
 178         metadata: {
 179             }
 180         description: An actor/operation/target definition
 181     onap.datatype.controlloop.Operation:
 182         constraints: [
 183             ]
 184         properties:
 185             failure_retries:
 186                 name: failure_retries
 187                 type: string
 188                 typeVersion: 0.0.0
 189                 description: Points to the operation to invoke when the current operation
 190                     has exceeded its max retries.
 191                 default: final_failure_retries
 192                 required: false
 193                 constraints: [
 194                     ]
 195                 metadata: {
 196                     }
 197             id:
 198                 name: id
 199                 type: string
 200                 typeVersion: 0.0.0
 201                 description: Unique identifier for the operation
 202                 required: true
 203                 constraints: [
 204                     ]
 205                 metadata: {
 206                     }
 207             failure_timeout:
 208                 name: failure_timeout
 209                 type: string
 210                 typeVersion: 0.0.0
 211                 description: Points to the operation to invoke when the time out for
 212                     the operation occurs.
 213                 default: final_failure_timeout
 214                 required: false
 215                 constraints: [
 216                     ]
 217                 metadata: {
 218                     }
 219             failure:
 220                 name: failure
 221                 type: string
 222                 typeVersion: 0.0.0
 223                 description: Points to the operation to invoke on Actor operation
 224                     failure.
 225                 default: final_failure
 226                 required: false
 227                 constraints: [
 228                     ]
 229                 metadata: {
 230                     }
 231             operation:
 232                 name: operation
 233                 type: onap.datatype.controlloop.Actor
 234                 typeVersion: 0.0.0
 235                 description: The definition of the operation to be performed.
 236                 required: true
 237                 constraints: [
 238                     ]
 239                 metadata: {
 240                     }
 241             failure_guard:
 242                 name: failure_guard
 243                 type: string
 244                 typeVersion: 0.0.0
 245                 description: Points to the operation to invoke when the current operation
 246                     is blocked due to guard policy enforcement.
 247                 default: final_failure_guard
 248                 required: false
 249                 constraints: [
 250                     ]
 251                 metadata: {
 252                     }
 253             retries:
 254                 name: retries
 255                 type: integer
 256                 typeVersion: 0.0.0
 257                 description: The number of retries the actor should attempt to perform
 258                     the operation.
 259                 default: '0'
 260                 required: true
 261                 constraints: [
 262                     ]
 263                 metadata: {
 264                     }
 265             timeout:
 266                 name: timeout
 267                 type: integer
 268                 typeVersion: 0.0.0
 269                 description: The amount of time for the actor to perform the operation.
 270                 required: true
 271                 constraints: [
 272                     ]
 273                 metadata: {
 274                     }
 275             failure_exception:
 276                 name: failure_exception
 277                 type: string
 278                 typeVersion: 0.0.0
 279                 description: Points to the operation to invoke when the current operation
 280                     causes an exception.
 281                 default: final_failure_exception
 282                 required: false
 283                 constraints: [
 284                     ]
 285                 metadata: {
 286                     }
 287             description:
 288                 name: description
 289                 type: string
 290                 typeVersion: 0.0.0
 291                 description: A user-friendly description of the intent for the operation
 292                 required: false
 293                 constraints: [
 294                     ]
 295                 metadata: {
 296                     }
 297             success:
 298                 name: success
 299                 type: string
 300                 typeVersion: 0.0.0
 301                 description: Points to the operation to invoke on success. A value
 302                     of "final_success" indicates and end to the operation.
 303                 default: final_success
 304                 required: false
 305                 constraints: [
 306                     ]
 307                 metadata: {
 308                     }
 309         name: onap.datatype.controlloop.Operation
 310         version: 0.0.0
 311         derived_from: tosca.datatypes.Root
 312         metadata: {
 313             }
 314         description: An operation supported by an actor
 315     onap.datatype.controlloop.Target:
 316         constraints: [
 317             ]
 318         properties:
 319             entityIds:
 320                 name: entityIds
 321                 type: map
 322                 typeVersion: 0.0.0
 323                 description: |
 324                     Map of values that identify the resource. If none are provided, it is assumed that the
 325                     entity that generated the ONSET event will be the target.
 326                 required: false
 327                 constraints: [
 328                     ]
 329                 entry_schema:
 330                     type: string
 331                     typeVersion: 0.0.0
 332                     constraints: [
 333                         ]
 334                 metadata:
 335                     clamp_possible_values: ClampExecution:CSAR_RESOURCES
 336             targetType:
 337                 name: targetType
 338                 type: string
 339                 typeVersion: 0.0.0
 340                 description: Category for the target type
 341                 required: true
 342                 constraints:
 343                 -   valid_values:
 344                     - VNF
 345                     - VM
 346                     - VFMODULE
 347                     - PNF
 348                 metadata: {
 349                     }
 350         name: onap.datatype.controlloop.Target
 351         version: 0.0.0
 352         derived_from: tosca.datatypes.Root
 353         metadata: {
 354             }
 355         description: Definition for a entity in A&AI to perform a control loop operation
 356             on
 357 name: ToscaServiceTemplateSimple
 358 version: 1.0.0
 359 metadata: {
 360     }