text: #    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 oslo_versionedobjects import fields
  
  from magnum.common import exception
  from magnum.common import utils
  from magnum.db import api as dbapi
  from magnum.objects import base
  from magnum.objects import fields as m_fields
  
  
  @base.MagnumObjectRegistry.register
  class BayModel(base.MagnumPersistentObject, base.MagnumObject,
                 base.MagnumObjectDictCompat):
      # Version 1.0: Initial version
      # Version 1.1: Add 'registry_enabled' field
      # Version 1.2: Added 'network_driver' field
      # Version 1.3: Added 'labels' attribute
      # Version 1.4: Added 'insecure' attribute
      # Version 1.5: Changed type of 'coe' from StringField to BayTypeField
      # Version 1.6: Change 'insecure' to 'tls_disabled'
      # Version 1.7: Added 'public' field
      # Version 1.8: Added 'server_type' field
      # Version 1.9: Added 'volume_driver' field
      # Version 1.10: Removed 'ssh_authorized_key' field
      # Version 1.11: Added 'insecure_registry' field
      VERSION = '1.11'
  
      dbapi = dbapi.get_instance()
  
      fields = {
          'id': fields.IntegerField(),
          'uuid': fields.StringField(nullable=True),
          'project_id': fields.StringField(nullable=True),
          'user_id': fields.StringField(nullable=True),
          'name': fields.StringField(nullable=True),
          'image_id': fields.StringField(nullable=True),
          'flavor_id': fields.StringField(nullable=True),
          'master_flavor_id': fields.StringField(nullable=True),
          'keypair_id': fields.StringField(nullable=True),
          'dns_nameserver': fields.StringField(nullable=True),
          'external_network_id': fields.StringField(nullable=True),
          'fixed_network': fields.StringField(nullable=True),
          'network_driver': fields.StringField(nullable=True),
          'volume_driver': fields.StringField(nullable=True),
          'apiserver_port': fields.IntegerField(nullable=True),
          'docker_volume_size': fields.IntegerField(nullable=True),
          'cluster_distro': fields.StringField(nullable=True),
          'coe': m_fields.BayTypeField(nullable=True),
          'http_proxy': fields.StringField(nullable=True),
          'https_proxy': fields.StringField(nullable=True),
          'no_proxy': fields.StringField(nullable=True),
          'registry_enabled': fields.BooleanField(default=False),
          'labels': fields.DictOfStringsField(nullable=True),
          'tls_disabled': fields.BooleanField(default=False),
          'public': fields.BooleanField(default=False),
          'server_type': fields.StringField(nullable=True),
          'insecure_registry': fields.StringField(nullable=True),
      }
  
      @staticmethod
      def _from_db_object(baymodel, db_baymodel):
          """Converts a database entity to a formal object."""
          for field in baymodel.fields:
              baymodel[field] = db_baymodel[field]
  
          baymodel.obj_reset_changes()
          return baymodel
  
      @staticmethod
      def _from_db_object_list(db_objects, cls, context):
          """Converts a list of database entities to a list of formal objects."""
          return [BayModel._from_db_object(cls(context), obj) for obj in
                  db_objects]
  
      @base.remotable_classmethod
      def get(cls, context, baymodel_id):
          """Find a baymodel based on its id or uuid and return a BayModel object.
  
          :param baymodel_id: the id *or* uuid of a baymodel.
          :param context: Security context
          :returns: a :class:`BayModel` object.
          """
          if utils.is_int_like(baymodel_id):
              return cls.get_by_id(context, baymodel_id)
          elif utils.is_uuid_like(baymodel_id):
              return cls.get_by_uuid(context, baymodel_id)
          else:
              raise exception.InvalidIdentity(identity=baymodel_id)
  
      @base.remotable_classmethod
      def get_by_id(cls, context, baymodel_id):
          """Find a baymodel based on its integer id and return a BayModel object.
  
          :param baymodel_id: the id of a baymodel.
          :param context: Security context
          :returns: a :class:`BayModel` object.
          """
          db_baymodel = cls.dbapi.get_baymodel_by_id(context, baymodel_id)
          baymodel = BayModel._from_db_object(cls(context), db_baymodel)
          return baymodel
  
      @base.remotable_classmethod
      def get_by_uuid(cls, context, uuid):
          """Find a baymodel based on uuid and return a :class:`BayModel` object.
  
          :param uuid: the uuid of a baymodel.
          :param context: Security context
          :returns: a :class:`BayModel` object.
          """
          db_baymodel = cls.dbapi.get_baymodel_by_uuid(context, uuid)
          baymodel = BayModel._from_db_object(cls(context), db_baymodel)
          return baymodel
  
      @base.remotable_classmethod
      def get_by_name(cls, context, name):
          """Find a baymodel based on name and return a :class:`BayModel` object.
  
          :param name: the name of a baymodel.
          :param context: Security context
          :returns: a :class:`BayModel` object.
          """
          db_baymodel = cls.dbapi.get_baymodel_by_name(context, name)
          baymodel = BayModel._from_db_object(cls(context), db_baymodel)
          return baymodel
  
      @base.remotable_classmethod
      def list(cls, context, limit=None, marker=None,
               sort_key=None, sort_dir=None):
          """Return a list of BayModel objects.
  
          :param context: Security context.
          :param limit: maximum number of resources to return in a single result.
          :param marker: pagination marker for large data sets.
          :param sort_key: column to sort results by.
          :param sort_dir: direction to sort. "asc" or "desc".
          :returns: a list of :class:`BayModel` object.
  
          """
          db_baymodels = cls.dbapi.get_baymodel_list(context, limit=limit,
                                                     marker=marker,
                                                     sort_key=sort_key,
                                                     sort_dir=sort_dir)
          return BayModel._from_db_object_list(db_baymodels, cls, context)
  
      @base.remotable
      def create(self, context=None):
          """Create a BayModel record in the DB.
  
          :param context: Security context. NOTE: This should only
                          be used internally by the indirection_api.
                          Unfortunately, RPC requires context as the first
                          argument, even though we don't use it.
                          A context should be set when instantiating the
                          object, e.g.: BayModel(context)
  
          """
          values = self.obj_get_changes()
          db_baymodel = self.dbapi.create_baymodel(values)
          self._from_db_object(self, db_baymodel)
  
      @base.remotable
      def destroy(self, context=None):
          """Delete the BayModel from the DB.
  
          :param context: Security context. NOTE: This should only
                          be used internally by the indirection_api.
                          Unfortunately, RPC requires context as the first
                          argument, even though we don't use it.
                          A context should be set when instantiating the
                          object, e.g.: BayModel(context)
          """
          self.dbapi.destroy_baymodel(self.uuid)
          self.obj_reset_changes()
  
      @base.remotable
      def save(self, context=None):
          """Save updates to this BayModel.
  
          Updates will be made column by column based on the result
          of self.what_changed().
  
          :param context: Security context. NOTE: This should only
                          be used internally by the indirection_api.
                          Unfortunately, RPC requires context as the first
                          argument, even though we don't use it.
                          A context should be set when instantiating the
                          object, e.g.: BayModel(context)
          """
          updates = self.obj_get_changes()
          self.dbapi.update_baymodel(self.uuid, updates)
  
          self.obj_reset_changes()
  
      @base.remotable
      def refresh(self, context=None):
          """Loads updates for this BayModel.
  
          Loads a baymodel with the same uuid from the database and
          checks for updated attributes. Updates are applied from
          the loaded baymodel column by column, if there are any updates.
  
          :param context: Security context. NOTE: This should only
                          be used internally by the indirection_api.
                          Unfortunately, RPC requires context as the first
                          argument, even though we don't use it.
                          A context should be set when instantiating the
                          object, e.g.: BayModel(context)
          """
          current = self.__class__.get_by_uuid(self._context, uuid=self.uuid)
          for field in self.fields:
              if self.obj_attr_is_set(field) and self[field] != current[field]:
                  self[field] = current[field]
  