osdf/models/api/pciOptimizationRequest.py

   1 # -------------------------------------------------------------------------
   2 #   Copyright (c) 2018 AT&T Intellectual Property
   3 #
   4 #   Licensed under the Apache License, Version 2.0 (the "License");
   5 #   you may not use this file except in compliance with the License.
   6 #   You may obtain a copy of the License at
   7 #
   8 #       http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #   Unless required by applicable law or agreed to in writing, software
  11 #   distributed under the License is distributed on an "AS IS" BASIS,
  12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #   See the License for the specific language governing permissions and
  14 #   limitations under the License.
  15 #
  16 # -------------------------------------------------------------------------
  17 #
  18
  19 from schematics.types import BaseType, StringType, URLType, IntType
  20 from schematics.types.compound import ModelType, ListType, DictType
  21
  22 from .common import OSDFModel
  23
  24
  25 class RequestInfo(OSDFModel):
  26     """Info for northbound request from client such as SO"""
  27     transactionId = StringType(required=True)
  28     requestId = StringType(required=True)
  29     callbackUrl = URLType(required=True)
  30     callbackHeader = DictType(BaseType)
  31     sourceId = StringType(required=True)
  32     requestType = StringType(required=True)
  33     numSolutions = IntType()
  34     optimizers = ListType(StringType(required=True))
  35     timeout = IntType()
  36
  37
  38 class CellInfo(OSDFModel):
  39     """Information specific to CellInfo """
  40     networkId = StringType(required=True)
  41     cellIdList = ListType(StringType(required=True))
  42     trigger = StringType()
  43
  44
  45 class PCIOptimizationAPI(OSDFModel):
  46     """Request for PCI optimization """
  47     requestInfo = ModelType(RequestInfo, required=True)
  48     cellInfo = ModelType(CellInfo, required=True)