runtime/models/api/model_request.py

   1 # -------------------------------------------------------------------------
   2 #   Copyright (c) 2020 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 StringType
  20 from schematics.types.compound import ModelType
  21
  22 from osdf.models.api.common import OSDFModel
  23
  24
  25 class RequestInfo(OSDFModel):
  26     """Info for northbound request from client such as PCI-mS Handler"""
  27     transactionId = StringType(required=True)
  28     requestID = StringType(required=True)
  29     sourceId = StringType(required=True)
  30
  31
  32 class OptimModelInfo(OSDFModel):
  33     """Optimizer request info details."""
  34     # ModelId from the database
  35     modelId = StringType()
  36     # type of solver (mzn, or-tools, etc.)
  37     solver = StringType(required=True)
  38     # Description of the model
  39     description = StringType()
  40     # a large blob string containing the model (which is not that
  41     # problematic since models are fairly small).
  42     modelContent = StringType()
  43
  44
  45 class OptimModelRequestAPI(OSDFModel):
  46     """Request for Optimizer API (specific to optimization and additional metadata"""
  47     requestInfo = ModelType(RequestInfo, required=True)
  48     modelInfo = ModelType(OptimModelInfo, required=True)