Class Bundle

Defined in: rhqapi.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Bundle(param)

Field Summary
Field Attributes	Field Name and Description
	id

Method Summary
Method Attributes	Method Name and Description
	createDestination(group, name, target, baseName) creates a Bundle destination
	deploy(destination, params, version, isClean) deploys this bundle
	destinations(params) returns Bundle destinations based on query params
	getId()
	remove() removes this bundle from server
	versions(params) returns Bundle versions based on query params

Class Detail

Bundle(param)

Field Detail

{Number} id

Method Detail

{Bundle-Destination} createDestination(group, name, target, baseName)

creates a Bundle destination

Parameters:
{ResGroup} group: - must be COMPATIBLE and must contain resources supporting Bundle deployment
{String} name: of new destination, if null, name is taken from group
{String} target: - directory or path relative to `baseName` - if null, default is taken (this default defines ResourceType - so it will be based on baseName)
{String} baseName: - name of property found in group's ResourceType will be used as base when constructing target deploy directory - can be null when group's ResourceType defines exactly 1 baseName

{Bundle-Deployment} deploy(destination, params, version, isClean)

deploys this bundle

Parameters:
{Bundle-Destination} destination: - destination to be deployed to
{Object} params: - map of input parameters required by bundle
{Bundle-Version|String} version: - bundle version to be deployed, if null, latest version is used
{Boolean} isClean: - whether to perform clean deployment or not, default is true

{Bundle-Destination[]} destinations(params)

returns Bundle destinations based on query params

Parameters:

{Object} params

- filter See BundleResourceDeploymentCriteria class for available params There are also shortcuts for ENUM parameters: - you can use

{status:"success"} insetead of {BundleDeploymentStatus:"BundleDeploymentStatus.SUCCESS"}

{Number} getId()

remove()

removes this bundle from server

{Bundle-Version[]} versions(params)

returns Bundle versions based on query params

Parameters:
{Object} params: - filter See BundleVersionCriteria class for available params

Classes