PerformanceInformationAvailableNotification.schema.json

{
  "description": "This notification informs the receiver that performance information is available. The notification shall be triggered by the VNFM when new performance information collected by a PM job is available. The periodicity of triggering this notification is influenced by the  \"reportingPeriod\" attribute in the \"PmJobCriteria\" data structure.\n",
  "type": "object",
  "required": [
    "id",
    "notificationType",
    "timeStamp",
    "pmJobId",
    "objectType",
    "objectInstanceId",
    "_links"
  ],
  "properties": {
    "id": {
      "description": "An identifier with the intention of being globally unique.\n",
      "type": "string"
    },
    "notificationType": {
      "description": "Discriminator for the different notification types. Shall be set to \"PerformanceInformationAvailableNotification\" for this notification type.\n",
      "type": "string",
      "enum": [
        "PerformanceInformationAvailableNotification"
      ]
    },
    "timeStamp": {
      "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
      "type": "string",
      "format": "date-time"
    },
    "pmJobId": {
      "description": "An identifier with the intention of being globally unique.\n",
      "type": "string"
    },
    "objectType": {
      "description": "Type of the measured object. The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027.\n",
      "type": "string"
    },
    "objectInstanceId": {
      "description": "An identifier with the intention of being globally unique.\n",
      "type": "string"
    },
    "subObjectInstanceIds": {
      "description": "Identifiers of the sub-object instances of the measured object instance for which the measurements have been taken. Shall be present if the related PM job has been set up to measure only a subset of all sub-object instances of the measured object instance and a sub-object is defined in clause\n 6.2 of ETSI GS NFV-IFA 027 for the related measured object type.\nShall be absent otherwise.\n",
      "type": "array",
      "items": {
        "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
        "type": "string"
      }
    },
    "_links": {
      "description": "Links to resources related to this notification.\n",
      "type": "object",
      "required": [
        "pmJob",
        "performanceReport"
      ],
      "properties": {
        "objectInstance": {
          "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n",
          "type": "object",
          "required": [
            "href"
          ],
          "properties": {
            "href": {
              "description": "String formatted according to IETF RFC 3986.\n",
              "type": "string"
            }
          }
        },
        "pmJob": {
          "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n",
          "type": "object",
          "required": [
            "href"
          ],
          "properties": {
            "href": {
              "description": "String formatted according to IETF RFC 3986.\n",
              "type": "string"
            }
          }
        },
        "performanceReport": {
          "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n",
          "type": "object",
          "required": [
            "href"
          ],
          "properties": {
            "href": {
              "description": "String formatted according to IETF RFC 3986.\n",
              "type": "string"
            }
          }
        }
      }
    }
  }
}