CedarBackup2.config.LocalPeer

Package CedarBackup2 :: Module config :: Class LocalPeer |
[hide private]
[frames] | no frames]

# Class LocalPeer

source code

    object --+
             |
            LocalPeer

Class representing a Cedar Backup peer.

The following restrictions exist on data in this class:

- The peer name must be a non-empty string.
- The collect directory must be an absolute path.
- The ignore failure mode must be one of the values in VALID_FAILURE_MODES.

Instance Methods | [hide private]
__init__(self, name=None, collectDir=None, ignoreFailureMode=None) Constructor for the `LocalPeer` 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
_setName(self, value) Property target used to set the peer name. | source code
_getName(self) Property target used to get the peer name. | source code
_setCollectDir(self, value) Property target used to set the collect directory. | source code
_getCollectDir(self) Property target used to get the collect directory. | source code
_setIgnoreFailureMode(self, value) Property target used to set the ignoreFailure mode. | source code
_getIgnoreFailureMode(self) Property target used to get the ignoreFailure mode. | source code
Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties | [hide private]
| name Name of the peer, typically a valid hostname.
| collectDir Collect directory to stage files from on peer.
| ignoreFailureMode Ignore failure mode for peer.
Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, name=None, collectDir=None, ignoreFailureMode=None) (Constructor) | source code
Constructor for the `LocalPeer` class. Parameters: `name` - Name of the peer, typically a valid hostname. `collectDir` - Collect directory to stage files from on peer. `ignoreFailureMode` - Ignore failure mode for peer. Raises: `ValueError` - If one of the values is invalid. 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.

### _setName(self, value) | source code
Property target used to set the peer name. The value must be a non-empty string if it is not `None`. Raises: `ValueError` - If the value is an empty string.

### _setCollectDir(self, value) | source code
Property target used to set the collect directory. The value must be an absolute path if it is not `None`. It does not have to exist on disk at the time of assignment. Raises: `ValueError` - If the value is not an absolute path. `ValueError` - If the value cannot be encoded properly.

### _setIgnoreFailureMode(self, value) | source code
Property target used to set the ignoreFailure mode. If not `None`, the mode must be one of the values in VALID_FAILURE_MODES. Raises: `ValueError` - If the value is not valid.

Property Details | [hide private]

### name Name of the peer, typically a valid hostname. Get Method: _getName(self) - Property target used to get the peer name. Set Method: _setName(self, value) - Property target used to set the peer name.

### collectDir Collect directory to stage files from on peer. Get Method: _getCollectDir(self) - Property target used to get the collect directory. Set Method: _setCollectDir(self, value) - Property target used to set the collect directory.

### ignoreFailureMode Ignore failure mode for peer. Get Method: _getIgnoreFailureMode(self) - Property target used to get the ignoreFailure mode. Set Method: _setIgnoreFailureMode(self, value) - Property target used to set the ignoreFailure mode.