Class ExtensionsConfig
source code
object --+
|
ExtensionsConfig
Class representing Cedar Backup extensions configuration.
Extensions configuration is used to specify "extended
actions" implemented by code external to Cedar Backup. For
instance, a hypothetical third party might write extension code to
collect database repository data. If they write a properly-formatted
extension function, they can use the extension configuration to map a
command-line Cedar Backup action (i.e. "database") to their
function.
As with all of the other classes that represent configuration
sections, all of these values are optional. It is up to some
higher-level construct to decide whether everything they need is filled
in. Some validation is done on non-None
assignments
through the use of the Python property()
construct.
The following restrictions exist on data in this class:
-
If set, the order mode must be one of the values in
VALID_ORDER_MODES
-
The actions list must be a list of
ExtendedAction
objects.
|
__init__(self,
actions=None,
orderMode=None)
Constructor for the ExtensionsConfig class. |
source code
|
|
|
|
|
|
|
|
|
|
|
_getOrderMode(self)
Property target used to get the order mode. |
source code
|
|
|
|
|
_getActions(self)
Property target used to get the actions list. |
source code
|
|
Inherited from object :
__delattr__ ,
__getattribute__ ,
__hash__ ,
__new__ ,
__reduce__ ,
__reduce_ex__ ,
__setattr__
|
|
orderMode
Order mode for extensions, to control execution ordering.
|
|
actions
List of extended actions.
|
Inherited from object :
__class__
|
__init__(self,
actions=None,
orderMode=None)
(Constructor)
| source code
|
Constructor for the ExtensionsConfig class.
- Parameters:
actions - List of extended actions
- Overrides:
object.__init__
|
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__
|
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.
|
Property target used to set the order mode. The value must be one of
VALID_ORDER_MODES.
- Raises:
ValueError - If the value is not valid.
|
Property target used to set the actions list. Either the value must be
None or each element must be an
ExtendedAction .
- Raises:
ValueError - If the value is not a ExtendedAction
|
orderMode
Order mode for extensions, to control execution ordering.
- Get Method:
- _getOrderMode(self)
- Property target used to get the order mode.
- Set Method:
- _setOrderMode(self,
value)
- Property target used to set the order mode.
|
actions
List of extended actions.
- Get Method:
- _getActions(self)
- Property target used to get the actions list.
- Set Method:
- _setActions(self,
value)
- Property target used to set the actions list.
|