Pools.Pools Class Reference

Public Member Functions
def	AddPool (self, name)
def	AddPools (self, names)
def	DeletePool (self, name)
def	DeletePools (self, names)
def	GetPoolNames (self)
def	PurgePools (self, replacementPool="none", pools=[], overwrite=False)

Detailed Description

    Class used by DeadlineCon to send Pool requests. Additional
    Pool 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

AddPool()

def Pools.Pools.AddPool	(		self,
			name
	)

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

AddPools()

def Pools.Pools.AddPools	(		self,
			names
	)

 Adds some Pools to the repository.
    Params: names: List of Pool names to add.
    Returns: Success message.

DeletePool()

def Pools.Pools.DeletePool	(		self,
			name
	)

 Removes a Pool from the repository.
    Params: name: The Pool name.
    Returns: Success message.

DeletePools()

def Pools.Pools.DeletePools	(		self,
			names
	)

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

GetPoolNames()

def Pools.Pools.GetPoolNames

(

self

)

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

PurgePools()

def Pools.Pools.PurgePools	(		self,
			replacementPool = "none",
			pools = [],
			overwrite = False
	)

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

    Params: replacementPool: The Pool to replace obsolete Pools on purge.
            pools: The list of Pools to set or add.
            overwrite: Boolean flag that determines whether we are setting or adding Pools.
    Returns: Success message.