Groups.Groups Class Reference

Public Member Functions
def	AddGroup (self, name)
def	AddGroups (self, names)
def	DeleteGroup (self, name)
def	DeleteGroups (self, names)
def	GetGroupNames (self)
def	PurgeGroups (self, replacementGroup="none", groups=[], overwrite=False)

Detailed Description

    Class used by DeadlineCon to send Group requests. Additional
    Group requests related to Workers can be found in the Slaves.py file.
    Stores the address of the Web Service for use in sending requests.

Member Function Documentation

AddGroup()

def Groups.Groups.AddGroup	(		self,
			name
	)

 Adds a Group to the repository.
    Params: name: The Group name.
    Returns: Success message.

AddGroups()

def Groups.Groups.AddGroups	(		self,
			names
	)

 Adds some Groups to the repository.
    Params: names: List of Group names to add.
    Returns: Success message.

DeleteGroup()

def Groups.Groups.DeleteGroup	(		self,
			name
	)

 Removes a Group to the repository.
    Params: name: The Group name.
    Returns: Success message.

DeleteGroups()

def Groups.Groups.DeleteGroups	(		self,
			names
	)

 Removes some Groups from the repository.
    Params: names: List of Group names to remove.
    Returns: Success message.

GetGroupNames()

def Groups.Groups.GetGroupNames

(

self

)

 Gets the Group names.
    Returns: The list of Group names.

PurgeGroups()

def Groups.Groups.PurgeGroups	(		self,
			replacementGroup = "none",
			groups = [],
			overwrite = False
	)

 Purges obsolete Groups from repository using the provided replacementGroup. 
If Overwrite is set, the Groups provided will overwrite the old Groups and the 
replacementGroup must be a Group in the provided Groups list. If Overwrite is 
not set, the Groups provided will be added to the repository and obsolete Groups
will be purged using the replacement Group. If Overwrite is not set, then no Groups
are required.

    Params: replacementGroup: The Group to replace obsolete Groups on purge.
            groups: The list of Groups to set or add.
            overwrite: Boolean flag that determines whether we are setting or adding Groups.
    Returns: Success message.