CedarBackup2.extend.capacity.CapacityConfig

Package CedarBackup2 :: Package extend :: Module capacity :: Class CapacityConfig |
[hide private]
[frames] | no frames]

# Class CapacityConfig

source code

    object --+
             |
            CapacityConfig

Class representing capacity configuration.

The following restrictions exist on data in this class:

- The maximum percentage utilized must be a PercentageQuantity
- The minimum bytes remaining must be a ByteQuantity

Instance Methods | [hide private]
__init__(self, maxPercentage=None, minBytes=None) Constructor for the `CapacityConfig` class. | source code
__repr__(self) Official string representation for class instance. | source code
__str__(self) Informal string representation for class instance. | source code
__cmp__(self, other) Definition of equals operator for this class. | source code
_setMaxPercentage(self, value) Property target used to set the maxPercentage value. | source code
_getMaxPercentage(self) Property target used to get the maxPercentage value | source code
_setMinBytes(self, value) Property target used to set the bytes utilized value. | source code
_getMinBytes(self) Property target used to get the bytes remaining value. | source code
Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties | [hide private]
| maxPercentage Maximum percentage of the media that may be utilized.
| minBytes Minimum number of free bytes that must be available.
Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, maxPercentage=None, minBytes=None) (Constructor) | source code
Constructor for the `CapacityConfig` class. Parameters: `maxPercentage` - Maximum percentage of the media that may be utilized `minBytes` - Minimum number of free bytes that must be available Overrides: object.__init__

### __repr__(self) (Representation operator) | source code
Official string representation for class instance. Overrides: object.__repr__

### __str__(self) (Informal representation operator) | source code
Informal string representation for class instance. Overrides: object.__str__

### __cmp__(self, other) (Comparison operator) | source code
Definition of equals operator for this class. Parameters: `other` - Other object to compare to. Returns: -1/0/1 depending on whether self is `<`, `=` or `>` other.

### _setMaxPercentage(self, value) | source code
Property target used to set the maxPercentage value. If not `None`, the value must be a `PercentageQuantity` object. Raises: `ValueError` - If the value is not a `PercentageQuantity`

### _setMinBytes(self, value) | source code
Property target used to set the bytes utilized value. If not `None`, the value must be a `ByteQuantity` object. Raises: `ValueError` - If the value is not a `ByteQuantity`

Property Details | [hide private]

### maxPercentage Maximum percentage of the media that may be utilized. Get Method: _getMaxPercentage(self) - Property target used to get the maxPercentage value Set Method: _setMaxPercentage(self, value) - Property target used to set the maxPercentage value.

### minBytes Minimum number of free bytes that must be available. Get Method: _getMinBytes(self) - Property target used to get the bytes remaining value. Set Method: _setMinBytes(self, value) - Property target used to set the bytes utilized value.