new UserProvidedServices(endPoint)
Manage User Provided Services
https://docs.cloudfoundry.org/devguide/services/user-provided.html
Parameters:
Name | Type | Description |
---|---|---|
endPoint |
String | [CC endpoint] |
Methods
add(token_type, access_token, user_provided_service_options) → {JSON}
Create an user Provided Service
http://apidocs.cloudfoundry.org/217/user_provided_service_instances/creating_a_user_provided_service_instance.html
Parameters:
Name | Type | Description |
---|---|---|
token_type |
String | [Authentication type] |
access_token |
String | [Authentication token] |
user_provided_service_options |
JSON | [user_provided_service_options] |
Returns:
[return a JSON response]
- Type
- JSON
getService(token_type, access_token, service_guid) → {JSON}
Get a Service
http://apidocs.cloudfoundry.org/217/user_provided_service_instances/retrieve_a_particular_user_provided_service_instance.html
Parameters:
Name | Type | Description |
---|---|---|
token_type |
String | [Authentication type] |
access_token |
String | [Authentication token] |
service_guid |
String | [Service guid] |
Returns:
[return a JSON response]
- Type
- JSON
getServiceBindings(token_type, access_token, service_guid, filter) → {JSON}
Get service bindings from user provided services
http://apidocs.cloudfoundry.org/221/user_provided_service_instances/list_all_service_bindings_for_the_user_provided_service_instance.html
Parameters:
Name | Type | Description |
---|---|---|
token_type |
String | [Authentication type] |
access_token |
String | [Authentication token] |
service_guid |
String | [service_guid] |
filter |
JSON | [search options] |
Returns:
[Output]
- Type
- JSON
Example
var filter = {
q': 'app_guid:' + "65be2a2d-a643-4e01-b33d-8755d5934ae6"
};
getServices(token_type, access_token) → {JSON}
Get Services
http://apidocs.cloudfoundry.org/217/user_provided_service_instances/list_all_user_provided_service_instances.html
Parameters:
Name | Type | Description |
---|---|---|
token_type |
String | [Authentication type] |
access_token |
String | [Authentication token] |
Returns:
[return a JSON response]
- Type
- JSON
remove(token_type, access_token, service_guid) → {String}
Remove an User provided service
http://apidocs.cloudfoundry.org/217/user_provided_service_instances/delete_a_particular_user_provided_service_instance.html
Parameters:
Name | Type | Description |
---|---|---|
token_type |
String | [Authentication type] |
access_token |
String | [Authentication token] |
service_guid |
String | [service_guid] |
Returns:
[output]
- Type
- String
setEndPoint(endPoint)
Set endpoint
Parameters:
Name | Type | Description |
---|---|---|
endPoint |
String | [CC endpoint] |