Initial checkin for pci optimization code

[optf/osdf.git] / osdf / models / api / pciOptimizationRequest.py

diff --git a/osdf/models/api/pciOptimizationRequest.py b/osdf/models/api/pciOptimizationRequest.py
new file mode 100644 (file)
index 0000000..47b4eba
--- /dev/null
+++ b/osdf/models/api/pciOptimizationRequest.py
@@ -0,0 +1,48 @@
+# -------------------------------------------------------------------------
+#   Copyright (c) 2018 AT&T Intellectual Property
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# -------------------------------------------------------------------------
+#
+
+from schematics.types import BaseType, StringType, URLType, IntType
+from schematics.types.compound import ModelType, ListType, DictType
+
+from .common import OSDFModel
+
+
+class RequestInfo(OSDFModel):
+    """Info for northbound request from client such as SO"""
+    transactionId = StringType(required=True)
+    requestId = StringType(required=True)
+    callbackUrl = URLType(required=True)
+    callbackHeader = DictType(BaseType)
+    sourceId = StringType(required=True)
+    requestType = StringType(required=True)
+    numSolutions = IntType()
+    optimizers = ListType(StringType(required=True))
+    timeout = IntType()
+
+
+class CellInfo(OSDFModel):
+    """Information specific to CellInfo """
+    networkId = StringType(required=True)
+    cellIdList = ListType(StringType(required=True))
+    trigger = StringType()
+
+
+class PCIOptimizationAPI(OSDFModel):
+    """Request for PCI optimization """
+    requestInfo = ModelType(RequestInfo, required=True)
+    cellInfo = ModelType(CellInfo, required=True)