Constructor
new BuildPacks(endPointopt, optionsopt)
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
endPoint |
String |
<optional> |
Cloud Controller API endpoint URL | |
options |
Object |
<optional> |
{} | Options (same as CloudControllerBase) |
Methods
get(key) → {String}
Returns the URL for a well-known buildpack by key.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
String | Buildpack key (nodejs, java, php, python, static) |
Throws:
-
If key is unknown
- Type
- Error
Returns:
Buildpack GitHub URL
- Type
- String
getBuildPack(guid) → {Promise}
Get a single BuildPack by GUID
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | BuildPack unique identifier |
Returns:
Resolves with JSON buildpack object
- Type
- Promise
getBuildPacks(filteropt) → {Promise}
Get BuildPacks list from the API
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
filter |
Object |
<optional> |
Query-string filter options |
Returns:
Resolves with JSON buildpacks list
- Type
- Promise
remove(guid) → {Promise}
Delete a BuildPack
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | BuildPack unique identifier |
Returns:
Resolves when buildpack is deleted
- Type
- Promise
update(guid, buildPackOptions) → {Promise}
Update a BuildPack
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | BuildPack unique identifier |
buildPackOptions |
Object | Options to update |
Returns:
Resolves with JSON buildpack object
- Type
- Promise