runtime/models/api/optim_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 BaseType, DictType, StringType, IntType
  20 from schematics.types.compound import ModelType
  21
  22 from osdf.models.api.common import OSDFModel
  23
  24 """
  25 """
  26 class RequestInfo(OSDFModel):
  27     """Info for northbound request from client """
  28     transactionId = StringType(required=True)
  29     requestID = StringType(required=True)
  30     callbackUrl = StringType()
  31     sourceId = StringType(required=True)
  32     timeout = IntType()
  33
  34
  35 class DataInfo(OSDFModel):
  36     """Optimization data info"""
  37     text = StringType()
  38     json = DictType(BaseType)
  39
  40
  41 class OptimInfo(OSDFModel):
  42     """Optimizer request info details."""
  43     # ModelId from the database, if its not populated,
  44     # assume that solverModel will be populated.
  45     modelId = StringType()
  46     # type of solver (mzn, or-tools, etc.)
  47     solver = StringType()
  48     # Arguments for solver
  49     solverArgs = DictType(BaseType)
  50     # NOTE: a large blob string containing the model (which is not that
  51     # problematic since models are fairly small).
  52     modelContent = StringType()
  53     # Data Payload, input data for the solver
  54     optData = ModelType(DataInfo)
  55
  56
  57 class OptimizationAPI(OSDFModel):
  58     """Request for Optimizer API (specific to optimization and additional metadata"""
  59     requestInfo = ModelType(RequestInfo, required=True)
  60     optimInfo = ModelType(OptimInfo, required=True)