Home | Trees | Index | Help |
|
---|
Package CedarBackup2 :: Module config :: Class OptionsConfig |
|
object
--+
|
OptionsConfig
Class representing a Cedar Backup global options configuration.
The options section is used to store global configuration options and defaults that can be applied to other sections.
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.
"monday"
, "tuesday"
,
etc.
None
.
CommandOverride
objects.
ActionHook
objects.
Method Summary | |
---|---|
Constructor for the OptionsConfig class. | |
Official string representation for class instance. | |
Informal string representation for class instance. | |
Definition of equals operator for this class. | |
Property target used to get the backup group. | |
Property target used to get the backup user. | |
Property target used to get the command path hooks list. | |
Property target used to get the command path overrides list. | |
Property target used to get the rcp command. | |
Property target used to get the starting day. | |
Property target used to get the working directory. | |
Property target used to set the backup group. | |
Property target used to set the backup user. | |
Property target used to set the pre- and post-action hooks list. | |
Property target used to set the command path overrides list. | |
Property target used to set the rcp command. | |
Property target used to set the starting day. | |
Property target used to set the working directory. | |
Inherited from object | |
x.__delattr__('name') <==> del x.name | |
x.__getattribute__('name') <==> x.name | |
x.__hash__() <==> hash(x) | |
T.__new__(S, ...) -> a new object with type S, a subtype of T | |
helper for pickle | |
helper for pickle | |
x.__setattr__('name', value) <==> x.name = value |
Property Summary | |
---|---|
startingDay : Day that starts the week. | |
workingDir : Working (temporary) directory to use for backups. | |
backupUser : Effective user that backups should run as. | |
backupGroup : Effective group that backups should run as. | |
rcpCommand : Default rcp-compatible copy command for staging. | |
overrides : List of configured command path overrides, if any. | |
hooks : List of configured pre- and post-action hooks. |
Method Details |
---|
__init__(self,
startingDay=None,
workingDir=None,
backupUser=None,
backupGroup=None,
rcpCommand=None,
overrides=None,
hooks=None)
Constructor for the |
__repr__(self)
Official string representation for class instance.
|
__str__(self)
Informal string representation for class instance.
|
__cmp__(self,
other)
Definition of equals operator for this class.
|
_getBackupGroup(self)Property target used to get the backup group. |
_getBackupUser(self)Property target used to get the backup user. |
_getHooks(self)Property target used to get the command path hooks list. |
_getOverrides(self)Property target used to get the command path overrides list. |
_getRcpCommand(self)Property target used to get the rcp command. |
_getStartingDay(self)Property target used to get the starting day. |
_getWorkingDir(self)Property target used to get the working directory. |
_setBackupGroup(self, value)Property target used to set the backup group. The value must be a non-empty string if it is notNone .
|
_setBackupUser(self, value)Property target used to set the backup user. The value must be a non-empty string if it is notNone .
|
_setHooks(self, value)Property target used to set the pre- and post-action hooks list. Either the value must beNone or each element must be an
ActionHook .
|
_setOverrides(self, value)Property target used to set the command path overrides list. Either the value must beNone or each element must be a
CommandOverride .
|
_setRcpCommand(self, value)Property target used to set the rcp command. The value must be a non-empty string if it is notNone .
|
_setStartingDay(self, value)Property target used to set the starting day. If it is notNone , the value must be a valid English day of the week,
one of "monday" ,
"tuesday" , "wednesday" ,
etc.
|
_setWorkingDir(self, value)Property target used to set the working directory. The value must be an absolute path if it is notNone . It does not have to
exist on disk at the time of assignment.
|
Property Details |
---|
startingDayDay that starts the week.
|
workingDirWorking (temporary) directory to use for backups.
|
backupUserEffective user that backups should run as.
|
backupGroupEffective group that backups should run as.
|
rcpCommandDefault rcp-compatible copy command for staging.
|
overridesList of configured command path overrides, if any.
|
hooksList of configured pre- and post-action hooks. |
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Thu Mar 29 20:58:27 2007 | http://epydoc.sf.net |