o2ims/views/alarm_dto.py

   1 # Copyright (C) 2021 Wind River Systems, Inc.
   2 #
   3 #  Licensed under the Apache License, Version 2.0 (the "License");
   4 #  you may not use this file except in compliance with the License.
   5 #  You may obtain a copy of the License at
   6 #
   7 #      http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #  Unless required by applicable law or agreed to in writing, software
  10 #  distributed under the License is distributed on an "AS IS" BASIS,
  11 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #  See the License for the specific language governing permissions and
  13 #  limitations under the License.
  14
  15 from flask_restx import fields
  16
  17 from o2ims.views.api_ns import api_monitoring_v1
  18
  19
  20 class AlarmDTO:
  21
  22     alarm_event_record_get = api_monitoring_v1.model(
  23         "AlarmGetDto",
  24         {
  25             'alarmEventRecordId': fields.String(
  26                 required=True,
  27                 description='Alarm Event Record ID'),
  28             'resourceTypeId': fields.String,
  29             'resourceId': fields.String,
  30             'alarmDefinitionId': fields.String,
  31             'alarmRaisedTime': fields.String,
  32             'perceivedSeverity': fields.String,
  33         }
  34     )
  35
  36
  37 class SubscriptionDTO:
  38
  39     subscription_get = api_monitoring_v1.model(
  40         "AlarmSubscriptionGetDto",
  41         {
  42             'alarmSubscriptionId': fields.String(
  43                 required=True,
  44                 description='Alarm Subscription ID'),
  45             'callback': fields.String,
  46             'consumerSubscriptionId': fields.String,
  47             'filter': fields.String,
  48         }
  49     )
  50
  51     subscription = api_monitoring_v1.model(
  52         "AlarmSubscriptionCreateDto",
  53         {
  54             'callback': fields.String(
  55                 required=True,
  56                 description='Alarm Subscription callback address'),
  57             'consumerSubscriptionId': fields.String,
  58             'filter': fields.String,
  59         }
  60     )
  61
  62     subscription_post_resp = api_monitoring_v1.model(
  63         "AlarmSubscriptionCreatedRespDto",
  64         {
  65             'alarmSubscriptionId': fields.String(
  66                 required=True,
  67                 description='Alarm Subscription ID'),
  68         }
  69     )