OpenServiceBroker for .NET 0.4.3
client and a server .NET library for the Open Service Broker API specification
OpenServiceBroker.Instances.IServiceInstanceEndpoint Interface Reference

Represents a specific Service Instance with blocking operations. More...

Inheritance diagram for OpenServiceBroker.Instances.IServiceInstanceEndpoint:
OpenServiceBroker.Instances.IServiceInstanceEndpointBase< IServiceBindingEndpoint > OpenServiceBroker.Instances.ServiceInstanceBlockingEndpoint OpenServiceBroker.Instances.ServiceInstancePollingEndpoint

Public Member Functions

Task< ServiceInstanceProvisionProvisionAsync (ServiceInstanceProvisionRequest request)
 Provisions the Service Instance. More...
 
Task UpdateAsync (ServiceInstanceUpdateRequest request)
 Updates the Service Instance. More...
 
Task DeprovisionAsync (string serviceId, string planId)
 Deprovision the Service Instance. More...
 
- Public Member Functions inherited from OpenServiceBroker.Instances.IServiceInstanceEndpointBase< IServiceBindingEndpoint >
Task< ServiceInstanceResourceFetchAsync ()
 Fetches a Service Instance. More...
 

Additional Inherited Members

- Properties inherited from OpenServiceBroker.Instances.IServiceInstanceEndpointBase< IServiceBindingEndpoint >
IIndexerEndpoint< TServiceBindingEndpoint > ServiceBindings [get]
 Exposes bindings for this Service Instance.
 

Detailed Description

Represents a specific Service Instance with blocking operations.

What a Service Instance represents can vary by service. Examples include a single database on a multi-tenant server, a dedicated cluster, or an account on a web application.

Member Function Documentation

◆ DeprovisionAsync()

Task OpenServiceBroker.Instances.IServiceInstanceEndpoint.DeprovisionAsync ( string  serviceId,
string  planId 
)

Deprovision the Service Instance.

Parameters
serviceIdThe id of the service associated with the instance being deleted.
planIdThe id of the plan associated with the instance being deleted.
Exceptions
GoneExceptionThe instance does not exist (anymore).

Implemented in OpenServiceBroker.Instances.ServiceInstanceBlockingEndpoint, and OpenServiceBroker.Instances.ServiceInstancePollingEndpoint.

◆ ProvisionAsync()

Task< ServiceInstanceProvision > OpenServiceBroker.Instances.IServiceInstanceEndpoint.ProvisionAsync ( ServiceInstanceProvisionRequest  request)

Provisions the Service Instance.

Parameters
requestParameters for the requested Service Instance provision.
Exceptions
ConflictExceptionAn instance with the same id already exists but with different attributes.
Returns
The provisioned instance.

Implemented in OpenServiceBroker.Instances.ServiceInstanceBlockingEndpoint, and OpenServiceBroker.Instances.ServiceInstancePollingEndpoint.

◆ UpdateAsync()

Task OpenServiceBroker.Instances.IServiceInstanceEndpoint.UpdateAsync ( ServiceInstanceUpdateRequest  request)

Updates the Service Instance.

Parameters
requestParameters for the requested Service Instance update.
Exceptions
BrokerExceptionThe requested change is not supported.

Implemented in OpenServiceBroker.Instances.ServiceInstanceBlockingEndpoint, and OpenServiceBroker.Instances.ServiceInstancePollingEndpoint.


The documentation for this interface was generated from the following file: