Deadline Standalone Python Reference  10.2.1.1
Balancer.Balancer Class Reference

Public Member Functions

def DeleteBalancer (self, name)
 
def GetBalancerInfo (self, name)
 
def GetBalancerInfos (self, names=None)
 
def GetBalancerInfoSettings (self, name)
 
def GetBalancerInfoSettingsList (self, names=None)
 
def GetBalancerNames (self)
 
def GetBalancerSettings (self, name)
 
def GetBalancerSettingsList (self, names=None)
 
def SaveBalancerInfo (self, info)
 
def SaveBalancerSettings (self, settings)
 

Detailed Description

    Class used by DeadlineCon to send Balancer requests. 
    Stores the address of the Web Service for use in sending requests.

Member Function Documentation

◆ DeleteBalancer()

def Balancer.Balancer.DeleteBalancer (   self,
  name 
)
 Deletes the Balancer instance associated with the name provided.
    Input: name: The Balancer name to delete.
    Returns: Success message.

◆ GetBalancerInfo()

def Balancer.Balancer.GetBalancerInfo (   self,
  name 
)
 Gets a Balancer info.
    Input: name: The Balancer name.
    Returns: The Balancer info.

◆ GetBalancerInfos()

def Balancer.Balancer.GetBalancerInfos (   self,
  names = None 
)
 Gets a list of Balancer infos.
    Input: name: The Balancer names to be retrieved. If None then gets all Balancer infos.
    Returns: The Balancer infos.

◆ GetBalancerInfoSettings()

def Balancer.Balancer.GetBalancerInfoSettings (   self,
  name 
)
 Gets a Balancer info settings.
    Input: name: The Balancer name.
    Returns: The Balancer info settings.

◆ GetBalancerInfoSettingsList()

def Balancer.Balancer.GetBalancerInfoSettingsList (   self,
  names = None 
)
 Gets a list of Balancer info settings.
    Input: name: The Balancer names to be retrieved. If None then gets all Balancer info settings.
    Returns: The Balancer info settings.

◆ GetBalancerNames()

def Balancer.Balancer.GetBalancerNames (   self)
 Gets all the Balancer names.
    Returns: The list of Balancer names.

◆ GetBalancerSettings()

def Balancer.Balancer.GetBalancerSettings (   self,
  name 
)
 Gets a Balancer settings.
    Input: name: The Balancer name.
    Returns: The Balancer settings.

◆ GetBalancerSettingsList()

def Balancer.Balancer.GetBalancerSettingsList (   self,
  names = None 
)
 Gets a list of Balancer settings.
    Input: name: The Balancer names to be retrieved. If None then gets all Balancer settings.
    Returns: The Balancer settings.

◆ SaveBalancerInfo()

def Balancer.Balancer.SaveBalancerInfo (   self,
  info 
)
 Saves a Balancer info to the database.
    Input: info: Json object of the Balancer info.
    Returns: Success message.

◆ SaveBalancerSettings()

def Balancer.Balancer.SaveBalancerSettings (   self,
  settings 
)
 Saves a Balancer settings to the database.
    Input: settings: Json object of the Balancer settings.
    Returns: Success message.