OpenServiceBroker for .NET 0.4.4
client and a server .NET library for the Open Service Broker API specification
OpenServiceBroker.Instances.ServiceInstancePollingEndpoint Class Reference

Represents a specific Service Instance. Uses potentially deferred (asynchronous) operations and automatically handles polling to make them appear blocking. More...

Inheritance diagram for OpenServiceBroker.Instances.ServiceInstancePollingEndpoint:
OpenServiceBroker.Instances.ServiceInstanceEndpointBase< IServiceBindingEndpoint, ServiceBindingPollingEndpoint > OpenServiceBroker.Instances.IServiceInstanceEndpoint OpenServiceBroker.Instances.IServiceInstanceEndpointBase< IServiceBindingEndpoint >

Public Member Functions

 ServiceInstancePollingEndpoint (IEndpoint referrer, Uri relativeUri)
 Creates a new polling Service Instance endpoint. More...
 
async Task< ServiceInstanceProvisionProvisionAsync (ServiceInstanceProvisionRequest request)
 Provisions the Service Instance. More...
 
async Task UpdateAsync (ServiceInstanceUpdateRequest request)
 Updates the Service Instance. More...
 
async Task DeprovisionAsync (string serviceId, string planId)
 Deprovision the Service Instance. More...
 
- Public Member Functions inherited from OpenServiceBroker.Instances.ServiceInstanceEndpointBase< IServiceBindingEndpoint, ServiceBindingPollingEndpoint >
async Task< ServiceInstanceResourceFetchAsync ()
 
- Public Member Functions inherited from OpenServiceBroker.Instances.IServiceInstanceEndpointBase< IServiceBindingEndpoint >
Task< ServiceInstanceResourceFetchAsync ()
 Fetches a Service Instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from OpenServiceBroker.Instances.ServiceInstanceEndpointBase< IServiceBindingEndpoint, ServiceBindingPollingEndpoint >
 ServiceInstanceEndpointBase (IEndpoint referrer, Uri relativeUri, bool acceptsIncomplete=false)
 Creates a new Service Instance endpoint. More...
 
- Properties inherited from OpenServiceBroker.Instances.ServiceInstanceEndpointBase< IServiceBindingEndpoint, ServiceBindingPollingEndpoint >
IIndexerEndpoint< TServiceBindingEndpointInterface > ServiceBindings [get]
 
- Properties inherited from OpenServiceBroker.Instances.IServiceInstanceEndpointBase< IServiceBindingEndpoint >
IIndexerEndpoint< TServiceBindingEndpoint > ServiceBindings [get]
 Exposes bindings for this Service Instance.
 

Detailed Description

Represents a specific Service Instance. Uses potentially deferred (asynchronous) operations and automatically handles polling to make them appear blocking.

Constructor & Destructor Documentation

◆ ServiceInstancePollingEndpoint()

OpenServiceBroker.Instances.ServiceInstancePollingEndpoint.ServiceInstancePollingEndpoint ( IEndpoint  referrer,
Uri  relativeUri 
)
inline

Creates a new polling Service Instance endpoint.

Parameters
referrerThe endpoint used to navigate to this one.
relativeUriThe URI of this endpoint relative to the referrer 's.

Member Function Documentation

◆ DeprovisionAsync()

async Task OpenServiceBroker.Instances.ServiceInstancePollingEndpoint.DeprovisionAsync ( string  serviceId,
string  planId 
)
inline

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).

Implements OpenServiceBroker.Instances.IServiceInstanceEndpoint.

◆ ProvisionAsync()

async Task< ServiceInstanceProvision > OpenServiceBroker.Instances.ServiceInstancePollingEndpoint.ProvisionAsync ( ServiceInstanceProvisionRequest  request)
inline

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.

Implements OpenServiceBroker.Instances.IServiceInstanceEndpoint.

◆ UpdateAsync()

async Task OpenServiceBroker.Instances.ServiceInstancePollingEndpoint.UpdateAsync ( ServiceInstanceUpdateRequest  request)
inline

Updates the Service Instance.

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

Implements OpenServiceBroker.Instances.IServiceInstanceEndpoint.


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