JSDoc: Class: AppsDeployment

Constructor

new AppsDeployment()

Source:

model/cloudcontroller/AppsDeployment.js, line 15

Methods

associateRoute(appGuid, routeGuid) → {Promise}

Associate a route with an app.

Parameters:

Name	Type	Description
`appGuid`	String
`routeGuid`	String

Source:

model/cloudcontroller/AppsDeployment.js, line 136

Returns:

Type: Promise

getAppRoutes(appGuid) → {Promise}

Get routes for an app.

Parameters:

Name	Type	Description
`appGuid`	String

Source:

model/cloudcontroller/AppsDeployment.js, line 121

Returns:

Type: Promise

getDroplets(appGuid) → {Promise}

Get droplets for an app (v3 only).

Parameters:

Name	Type	Description
`appGuid`	String

Source:

model/cloudcontroller/AppsDeployment.js, line 272

Returns:

Type: Promise

getEnvironmentVariables(appGuid) → {Promise}

Get environment variables for an app.

Parameters:

Name	Type	Description
`appGuid`	String

Source:

model/cloudcontroller/AppsDeployment.js, line 212

Returns:

Type: Promise

getInstances(appGuid) → {Promise}

Get instance information.

Parameters:

Name	Type	Description
`appGuid`	String

Source:

model/cloudcontroller/AppsDeployment.js, line 107

Returns:

Type: Promise

getPackages(appGuid) → {Promise}

Get packages for an app (v3 only).

Parameters:

Name	Type	Description
`appGuid`	String

Source:

model/cloudcontroller/AppsDeployment.js, line 288

Returns:

Type: Promise

getProcesses(appGuid) → {Promise}

Get processes for an app (v3 only).

Parameters:

Name	Type	Description
`appGuid`	String

Source:

model/cloudcontroller/AppsDeployment.js, line 304

Returns:

Type: Promise

getServiceBindings(appGuid, filteropt) → {Promise}

Get service bindings for an app.

Parameters:

Name	Type	Attributes	Description
`appGuid`	String
`filter`	Object	<optional>

Source:

model/cloudcontroller/AppsDeployment.js, line 162

Returns:

Type: Promise

getStats(appGuid) → {Promise}

Get detailed stats for a started app.

Parameters:

Name	Type	Description
`appGuid`	String

Source:

model/cloudcontroller/AppsDeployment.js, line 92

Returns:

Type: Promise

removeServiceBindings(appGuid, serviceBindingGuid) → {Promise}

Remove a service binding from an app. v3: DELETE /v3/service_credential_bindings/:guid → 202 (managed, async) or 204 (key/UPS, sync) v2: DELETE /v2/apps/:guid/service_bindings/:guid → 204

Parameters:

Name	Type	Description
`appGuid`	String
`serviceBindingGuid`	String

Source:

model/cloudcontroller/AppsDeployment.js, line 188

Returns:

Type: Promise

restage(appGuid) → {Promise}

Restage an application (v2 only).

Parameters:

Name	Type	Description
`appGuid`	String

Source:

model/cloudcontroller/AppsDeployment.js, line 254

Returns:

Type: Promise

setEnvironmentVariables(appGuid, variables) → {Promise}

Set environment variables for an app. NOTE: v2 path calls this.update() — only works when mixed into Apps facade.

Parameters:

Name	Type	Description
`appGuid`	String
`variables`	Object

Source:

model/cloudcontroller/AppsDeployment.js, line 228

Returns:

Type: Promise

upload(appGuid, filePath, asyncopt) → {Promise}

Upload application source code.

Parameters:

Name	Type	Attributes	Default	Description
`appGuid`	String
`filePath`	String			Local file path to zip
`async`	Boolean	<optional>	false

Source:

model/cloudcontroller/AppsDeployment.js, line 28

Returns:

Type: Promise