Class: Services

Services(endPoint, options) → {void}

Manage Services on Cloud Foundry Supports both Cloud Foundry API v2 and v3

Constructor

new Services(endPoint, options) → {void}

Parameters:

Name	Type	Description
`endPoint`	String	[CC endpoint]
`options`	Object	[Configuration options]

Source:

model/cloudcontroller/Services.js, line 9

Returns:

Type: void

Methods

disableServiceForOrganization(serviceGuid, orgGuid) → {Promise}

Disable a Service for a particular organization (v2 only) http://apidocs.cloudfoundry.org/214/services/disable_a_purchased_service_for_a_particular_organization.html

Parameters:

Name	Type	Description
`serviceGuid`	String	[Service GUID]
`orgGuid`	String	[Organization GUID]

Source:

model/cloudcontroller/Services.js, line 204

Returns:

[Promise resolving to delete result]

Type: Promise

enableServiceForOrganization(serviceGuid, orgGuid) → {Promise}

Enable a Service for a particular organization (v2 only) http://apidocs.cloudfoundry.org/214/services/enable_a_purchased_service_for_a_particular_organization.html

Parameters:

Name	Type	Description
`serviceGuid`	String	[Service GUID]
`orgGuid`	String	[Organization GUID]

Source:

model/cloudcontroller/Services.js, line 175

Returns:

[Promise resolving to enabled service]

Type: Promise

getService(guid) → {Promise}

Get a specific Service by GUID v2: http://apidocs.cloudfoundry.org/214/services/retrieve_a_particular_service.html v3: https://v3-apidocs.cloudfoundry.org/#get-a-service-offering

Parameters:

Name	Type	Description
`guid`	String	[Service GUID]

Source:

model/cloudcontroller/Services.js, line 79

Returns:

[Promise resolving to service]

Type: Promise

getServicePlans(guid, filter) → {Promise}

Get service plans for a Service v2: http://apidocs.cloudfoundry.org/214/services/list_all_service_plans_for_the_service.html v3: https://v3-apidocs.cloudfoundry.org/#list-service-plans

Parameters:

Name	Type	Description
`guid`	String	[Service GUID]
`filter`	Object	[Filter options]

Source:

model/cloudcontroller/Services.js, line 124

Returns:

[Promise resolving to service plans list]

Type: Promise

getServices(filter) → {Promise}

Get Services (supports both v2 and v3) v2: http://apidocs.cloudfoundry.org/214/services/list_all_services.html v3: https://v3-apidocs.cloudfoundry.org/#list-service-offerings

Parameters:

Name	Type	Description
`filter`	Object	[Filter options]

Source:

model/cloudcontroller/Services.js, line 29

Returns:

[Promise resolving to services list]

Type: Promise