Slaves.Slaves Class Reference

Public Member Functions
def	AddGroupToSlave (self, slave, group)
def	AddPoolToSlave (self, slave, pool)
def	DeleteSlave (self, name)
def	GetSlaveHistoryEntries (self, name)
def	GetSlaveInfo (self, name)
def	GetSlaveInfos (self, names=None)
def	GetSlaveInfoSettings (self, name)
def	GetSlaveNames (self)
def	GetSlaveNamesInGroup (self, group)
def	GetSlaveNamesInPool (self, pool)
def	GetSlaveReports (self, name)
def	GetSlaveReportsContents (self, name)
def	GetSlaveSettings (self, name)
def	GetSlavesInfoSettings (self, names=None)
def	GetSlavesSettings (self, names=None)
def	RemoveGroupFromSlave (self, slave, group)
def	RemovePoolFromSlave (self, slave, pool)
def	SaveSlaveInfo (self, info)
def	SaveSlaveSettings (self, info)
def	SetGroupsForSlave (self, slave, group=[])
def	SetPoolsForSlave (self, slave, pool=[])

Detailed Description

    Class used by DeadlineCon to send Worker requests, as well as a few Pool and Group requests.
    Stores the address of the Web Service for use in sending requests.

Member Function Documentation

AddGroupToSlave()

def Slaves.Slaves.AddGroupToSlave	(		self,
			slave,
			group
	)

 Adds a Group to a Worker.
    Input:  slave: The name of the Worker or Workers (may be a list).
            group: The name of the Group or Groups (may be a list).
    Returns: Success message.

AddPoolToSlave()

def Slaves.Slaves.AddPoolToSlave	(		self,
			slave,
			pool
	)

 Adds a Pool to a Worker.
    Input:  slave: The name of the Worker or Workers (may be a list).
            pool: The name of the Pool or Pools (may be a list).
    Returns: Success message.

DeleteSlave()

def Slaves.Slaves.DeleteSlave	(		self,
			name
	)

 Removes a Worker from the repository.
    Input:  name: The name of the Worker to be removed.
    Returns: Success message.

GetSlaveHistoryEntries()

def Slaves.Slaves.GetSlaveHistoryEntries	(		self,
			name
	)

 Gets the history entries for a Worker.
    Input:  name: The name of the Worker.
    Returns: All history entries for the Worker.

GetSlaveInfo()

def Slaves.Slaves.GetSlaveInfo	(		self,
			name
	)

 Gets a Worker info object.
    Input: name: The Worker name.
    Returns: The Worker info.

GetSlaveInfos()

def Slaves.Slaves.GetSlaveInfos	(		self,
			names = None
	)

 Gets multiple Worker info objects.
    Input: name: The Worker names. If None return all info for all Workers.
    Returns: List of the Worker infos.

GetSlaveInfoSettings()

def Slaves.Slaves.GetSlaveInfoSettings	(		self,
			name
	)

 Gets a Worker info settings.
    Input: name: The Worker name.
    Returns: The Worker info settings.

GetSlaveNames()

def Slaves.Slaves.GetSlaveNames

(

self

)

 Gets all the Worker names.
    Returns: The list of Worker names.

GetSlaveNamesInGroup()

def Slaves.Slaves.GetSlaveNamesInGroup	(		self,
			group
	)

 Gets the names of all Workers in a specific Group.
    Input:  group: The name of the Group to search in (may be a list).
    Returns: A list of all Workers that are in the Groups.

GetSlaveNamesInPool()

def Slaves.Slaves.GetSlaveNamesInPool	(		self,
			pool
	)

 Gets the names of all Workers in a specific Pool.
    Input:  pool: The name of the Pool to search in (may be a list).
    Returns: A list of all Workers that are in the Pool.

GetSlaveReports()

def Slaves.Slaves.GetSlaveReports	(		self,
			name
	)

 Gets the reports for a Worker.
    Input:  name: The name of the Worker.
    Returns: All reports for the Worker.

GetSlaveReportsContents()

def Slaves.Slaves.GetSlaveReportsContents	(		self,
			name
	)

 Gets the reports contents for a Worker.
    Input:  name: The name of the Worker.
    Returns: All reports contents for the Worker.

GetSlaveSettings()

def Slaves.Slaves.GetSlaveSettings	(		self,
			name
	)

 Gets a Worker settings object.
    Input: name: The Worker name.
    Returns: The Worker settings.

GetSlavesInfoSettings()

def Slaves.Slaves.GetSlavesInfoSettings	(		self,
			names = None
	)

 Gets multiple Worker info settings.
    Inputs: names: The names of the Workers to get. If None get all Workers.
    Returns: The list of Workers' infos and settings.

GetSlavesSettings()

def Slaves.Slaves.GetSlavesSettings	(		self,
			names = None
	)

 Gets multiple Worker settings objects.
    Input: name: The Worker names. If None return all info for all Workers.
    Returns: List of the Worker settings's info.

RemoveGroupFromSlave()

def Slaves.Slaves.RemoveGroupFromSlave	(		self,
			slave,
			group
	)

 Adds a Group from a Worker.
    Input:  slave: The name of the Worker or Workers (may be a list).
            group: The name of the Group or Group (may be a list).
    Returns: Success message.

RemovePoolFromSlave()

def Slaves.Slaves.RemovePoolFromSlave	(		self,
			slave,
			pool
	)

 Adds a Pool from a Worker.
    Input:  slave: The name of the Worker or Workers (may be a list).
            pool: The name of the Pool or Pools (may be a list).
    Returns: Success message.

SaveSlaveInfo()

def Slaves.Slaves.SaveSlaveInfo	(		self,
			info
	)

 Saves Worker info to the database.
    Input:  info: Json object of the Worker info.
    Returns: Success message.

SaveSlaveSettings()

def Slaves.Slaves.SaveSlaveSettings	(		self,
			info
	)

 Saves Worker Settings to the database.
    Input:  info: Json object of the Worker settings.
    Returns: Success message.

SetGroupsForSlave()

def Slaves.Slaves.SetGroupsForSlave	(		self,
			slave,
			group = []
	)

 Sets all of the Groups for one or more Workers overriding their old lists.
    Input:  slave: Workers to be modified (may be a list).
            pool: List of Groups to be used.
    Returns: Success message.

SetPoolsForSlave()

def Slaves.Slaves.SetPoolsForSlave	(		self,
			slave,
			pool = []
	)

 Sets all of the Pools for one or more Workers overriding their old lists.
    Input:  slave: Workers to be modified (may be a list).
            pool: List of Pools to be used.
    Returns: Success message.