Class Index | File Index

Classes


Namespace resources

provides access to resources in inventory
Defined in: rhqapi.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
resources.find(params)
finds resources in inventory
<static>  
resources.platform(params)
returns 1st platform found based on given params or just nothing
<static>  
resources.platforms(params)
Namespace Detail
resources
Method Detail
<static> {Resource[]} resources.find(params)
finds resources in inventory
resources.find({type:"RHQ Agent",name:"RHQ Agent",availability:"down"});
resources.find({type:"JBoss AS7 Standalone Server",parentResourceId:12345});
Parameters:
{Object} params
- see ResourceCriteria.addFilter[param] methods for available params. There are also shortcuts for ENUM parameters: - you can use
  • {status:"new"} insetead of {InventoryStatus:"InventoryStatus.NEW"}
  • {category:"platform"} instead of {ResourceCategory:"ResourceCategory.PLATTFORM"}
  • {availability:"up"} instead of {AvailabilityType:"AvailabilityType.UP}
  • {type:"RHQ Agent"} instead of {resourceTypeName:"RHQ Agent"}
Returns:
array of resources

<static> {Resource} resources.platform(params)
returns 1st platform found based on given params or just nothing
Parameters:
params

<static> {Array} resources.platforms(params)
Parameters:
params
Returns:
array of platforms in inventory

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jan 06 2014 16:48:32 GMT+0100 (CET)