cf-node-client
momo auto_awesome BUY CLAUDE KIT WITH 20% OFF coffee BUY ME COFFEE

Class: ServiceBindings

ServiceBindings(endPoint, options) → {void}

Manage Service Bindings on Cloud Foundry Supports both Cloud Foundry API v2 and v3

Constructor

new ServiceBindings(endPoint, options) → {void}

Parameters:
Name Type Description
endPoint String [CC endpoint]
options Object [Configuration options]
Source:
Returns:
Type
void

Methods

add(bindingOptions) → {Promise}

Create a Service Binding v2: http://apidocs.cloudfoundry.org/226/service_bindings/create_a_service_binding.html v3: https://v3-apidocs.cloudfoundry.org/#create-a-service-credential-binding
Parameters:
Name Type Description
bindingOptions Object [Service Binding options]
Source:
Returns:
[Promise resolving to created service binding]
Type
Promise

getServiceBinding(guid) → {Promise}

Get a Service Binding by GUID v2: http://apidocs.cloudfoundry.org/226/service_bindings/retrieve_a_particular_service_binding.html v3: https://v3-apidocs.cloudfoundry.org/#get-a-service-credential-binding
Parameters:
Name Type Description
guid String [Service Binding GUID]
Source:
Returns:
[Promise resolving to service binding]
Type
Promise

getServiceBindings(filter) → {Promise}

Get Service Bindings (supports both v2 and v3) v2: http://apidocs.cloudfoundry.org/226/service_bindings/list_all_service_bindings.html v3: https://v3-apidocs.cloudfoundry.org/#list-service-credential-bindings
Parameters:
Name Type Description
filter Object [Filter options]
Source:
Returns:
[Promise resolving to service bindings list]
Type
Promise

remove(guid, deleteOptions) → {Promise}

Delete a Service Binding v2: http://apidocs.cloudfoundry.org/226/service_bindings/delete_a_service_binding.html v3: https://v3-apidocs.cloudfoundry.org/#delete-a-service-credential-binding
Parameters:
Name Type Description
guid String [Service Binding GUID]
deleteOptions Object [Delete options]
Source:
Returns:
[Promise resolving to delete result]
Type
Promise

update(guid, bindingOptions) → {Promise}

Update a Service Binding v2: http://apidocs.cloudfoundry.org/226/service_bindings/updating_a_service_binding.html v3: https://v3-apidocs.cloudfoundry.org/#update-a-service-credential-binding
Parameters:
Name Type Description
guid String [Service Binding GUID]
bindingOptions Object [Service Binding options]
Source:
Returns:
[Promise resolving to updated service binding]
Type
Promise