Source code for cloudkitty.rating.hash.datamodels.threshold

# -*- coding: utf-8 -*-
# Copyright 2015 Objectif Libre
#
#    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.
#
import decimal

from wsme import types as wtypes

from cloudkitty.api.v1 import types as ck_types
from cloudkitty.rating.hash.datamodels import mapping as mapping_models




class Threshold(wtypes.Base):
    """Type describing a Threshold.

    A threshold is used to apply rating rules based on a level, if the parent
    is a field then the level is checked against a metadata. If it's a service
    then it's the quantity of the resource that is checked.
    """

    threshold_id = wtypes.wsattr(ck_types.UuidType(), mandatory=False)
    """UUID of the threshold."""

    level = wtypes.wsattr(decimal.Decimal,
                          mandatory=True,
                          default=decimal.Decimal('0'))
    """Level of the threshold."""

    map_type = wtypes.wsattr(mapping_models.MAP_TYPE,
                             default='flat',
                             name='type')
    """Type of the threshold."""

    cost = wtypes.wsattr(decimal.Decimal, mandatory=True)
    """Value of the threshold."""

    service_id = wtypes.wsattr(ck_types.UuidType(),
                               mandatory=False)
    """UUID of the service."""

    field_id = wtypes.wsattr(ck_types.UuidType(),
                             mandatory=False)
    """UUID of the field."""

    group_id = wtypes.wsattr(ck_types.UuidType(),
                             mandatory=False)
    """UUID of the hashmap group."""

    tenant_id = wtypes.wsattr(wtypes.text, mandatory=False, default=None)
    """ID of the hashmap tenant."""

    @classmethod
    def sample(cls):
        sample = cls(threshold_id='39dbd39d-f663-4444-a795-fb19d81af136',
                     field_id='ac55b000-a05b-4832-b2ff-265a034886ab',
                     level=decimal.Decimal('1024'),
                     map_type='flat',
                     cost=decimal.Decimal('4.2'),
                     tenant_id='7977999e-2e25-11e6-a8b2-df30b233ffcb')
        return sample





class ThresholdCollection(wtypes.Base):
    """Type describing a list of mappings.

    """

    thresholds = [Threshold]
    """List of thresholds."""

    @classmethod
    def sample(cls):
        sample = Threshold.sample()
        return cls(thresholds=[sample])