apps/placement/models/api/placementResponse.py

   1 # -------------------------------------------------------------------------
   2 #   Copyright (c) 2015-2017 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 osdf.models.api.common import OSDFModel
  20 from schematics.types import BaseType, StringType
  21 from schematics.types.compound import ModelType, ListType, DictType
  22
  23
  24 # TODO: update osdf.models
  25
  26 class LicenseSolution(OSDFModel):
  27     serviceResourceId = StringType(required=True)
  28     resourceModuleName = StringType(required=True)
  29     entitlementPoolUUID = ListType(StringType(required=True))
  30     licenseKeyGroupUUID = ListType(StringType(required=True))
  31     entitlementPoolInvariantUUID = ListType(StringType(required=True))
  32     licenseKeyGroupInvariantUUID = ListType(StringType(required=True))
  33
  34
  35 class Candidates(OSDFModel):
  36     """Preferred candidate for a resource (sent as part of a request from client)"""
  37     identifierType = StringType(required=True)
  38     identifiers = ListType(StringType(required=True))
  39     cloudOwner = StringType()
  40
  41
  42 class AssignmentInfo(OSDFModel):
  43     key = StringType(required=True)
  44     value = BaseType(required=True)
  45
  46
  47 class PlacementSolution(OSDFModel):
  48     serviceResourceId = StringType(required=True)
  49     resourceModuleName = StringType(required=True)
  50     solution = ModelType(Candidates, required=True)
  51     assignmentInfo = ListType(ModelType(AssignmentInfo))
  52
  53
  54 class Solution(OSDFModel):
  55     placementSolutions = ListType(ListType(ModelType(PlacementSolution), min_size=1))
  56     licenseSolutions = ListType(ModelType(LicenseSolution), min_size=1)
  57
  58
  59 class PlacementResponse(OSDFModel):
  60     transactionId = StringType(required=True)
  61     requestId = StringType(required=True)
  62     requestStatus = StringType(required=True)
  63     statusMessage = StringType()
  64     solutions = ModelType(Solution, required=True)