hyperx.api.RundeckCol Class Reference

Inheritance diagram for hyperx.api.RundeckCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.RundeckCol rundeckCol)
	__iter__ (self)
	__len__ (self)
Rundeck	AddRundeck (self, str inputPath, str resultPath=None)
	The specified rundeck at the given filepath will be added to the project's collection of rundecks.
list[RundeckPathPair]	GetRundeckPathSetters (self)
	Get RundeckPathSetters to be edited and input to UpdateAllRundecks.
RundeckUpdateStatus	ReassignPrimary (self, int id)
	The specified rundeck will be updated to become the new primary rundeck.
RundeckRemoveStatus	RemoveRundeck (self, int id)
	The specified rundeck at the given filepath will be removed from the project's collection of rundecks.
RundeckBulkUpdateStatus	ReplaceStringInAllPaths (self, str stringToReplace, str newString)
	Replace a given string with a new string in every rundeck path.
RundeckBulkUpdateStatus	UpdateAllRundecks (self, tuple[RundeckPathPair] newPaths)
	Updates the path of all rundecks.
Public Member Functions inherited from hyperx.api.IdEntityCol
	__init__ (self, _api.IdEntityCol idEntityCol)
bool	Contains (self, int id)
int	Count (self)
IdEntity	Get (self, int id)

Protected Attributes
	_CollectedClass = Rundeck
Protected Attributes inherited from hyperx.api.IdEntityCol
	_Entity = idEntityCol

Properties
	RundeckColList = property
Properties inherited from hyperx.api.IdEntityCol
	Ids = property

Constructor & Destructor Documentation

__init__()

hyperx.api.RundeckCol.__init__	(		self,
		_api.RundeckCol	rundeckCol )

Member Function Documentation

__getitem__()

hyperx.api.RundeckCol.__getitem__	(		self,
		int	index )

__iter__()

hyperx.api.RundeckCol.__iter__

(

self

)

__len__()

hyperx.api.RundeckCol.__len__

(

self

)

AddRundeck()

Rundeck hyperx.api.RundeckCol.AddRundeck	(		self,
		str	inputPath,
		str	resultPath = None )

The specified rundeck at the given filepath will be added to the project's collection of rundecks.

Parameters

inputPath	The path to the rundeck
resultPath	The path to the rundeck's corresponding result file

GetRundeckPathSetters()

list[RundeckPathPair] hyperx.api.RundeckCol.GetRundeckPathSetters

(

self

)

Get RundeckPathSetters to be edited and input to UpdateAllRundecks.

ReassignPrimary()

RundeckUpdateStatus hyperx.api.RundeckCol.ReassignPrimary	(		self,
		int	id )

The specified rundeck will be updated to become the new primary rundeck.

It is best practice to call hyperx.api.Project.RegeneratePfem after reassigning the primary rundeck

RemoveRundeck()

RundeckRemoveStatus hyperx.api.RundeckCol.RemoveRundeck	(		self,
		int	id )

The specified rundeck at the given filepath will be removed from the project's collection of rundecks.

Parameters

id	The id of the rundeck to remove

ReplaceStringInAllPaths()

RundeckBulkUpdateStatus hyperx.api.RundeckCol.ReplaceStringInAllPaths	(		self,
		str	stringToReplace,
		str	newString )

Replace a given string with a new string in every rundeck path.

This is useful when pointing to rundecks of the same name in a new directory.

UpdateAllRundecks()

RundeckBulkUpdateStatus hyperx.api.RundeckCol.UpdateAllRundecks	(		self,
		tuple[RundeckPathPair]	newPaths )

Updates the path of all rundecks.

The order of newPaths should correspond with the rundeck ids (i.e. The first item in newPaths will update the primary rundeck's paths).

Member Data Documentation

_CollectedClass

hyperx.api.RundeckCol._CollectedClass = Rundeck

protected

Property Documentation

RundeckColList

hyperx.api.RundeckCol.RundeckColList = property

static

---

The documentation for this class was generated from the following file:

• C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py