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

Represents a specific Service Instance with potentially deferred (asynchronous) operations. More...

Inheritance diagram for OpenServiceBroker.Instances.ServiceInstanceDeferredEndpoint:
OpenServiceBroker.Instances.ServiceInstanceEndpointBase< IServiceBindingDeferredEndpoint, ServiceBindingDeferredEndpoint > OpenServiceBroker.Instances.IServiceInstanceDeferredEndpoint OpenServiceBroker.Instances.IServiceInstanceEndpointBase< IServiceBindingDeferredEndpoint >

Public Member Functions

 ServiceInstanceDeferredEndpoint (IEndpoint referrer, Uri relativeUri)
 Creates a new deferred Service Instance endpoint. More...
 
async Task< ServiceInstanceAsyncOperationProvisionAsync (ServiceInstanceProvisionRequest request)
 Provisions the Service Instance. More...
 
async Task< ServiceInstanceAsyncOperationUpdateAsync (ServiceInstanceUpdateRequest request)
 Updates the Service Instance. More...
 
async Task< AsyncOperationDeprovisionAsync (string? serviceId=null, string? planId=null)
 Deprovisions/deletes the Service Instance. More...
 
IPollingEndpoint< LastOperationResourceLastOperation (string? serviceId=null, string? planId=null, string? operation=null)
 Provides an endpoint to obtain the state of the last requested deferred (asynchronous) operation. More...
 
- Public Member Functions inherited from OpenServiceBroker.Instances.ServiceInstanceEndpointBase< IServiceBindingDeferredEndpoint, ServiceBindingDeferredEndpoint >
async Task< ServiceInstanceResourceFetchAsync ()
 
- Public Member Functions inherited from OpenServiceBroker.Instances.IServiceInstanceEndpointBase< IServiceBindingDeferredEndpoint >
Task< ServiceInstanceResourceFetchAsync ()
 Fetches a Service Instance. More...
 

Additional Inherited Members

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

Detailed Description

Represents a specific Service Instance with potentially deferred (asynchronous) operations.

Constructor & Destructor Documentation

◆ ServiceInstanceDeferredEndpoint()

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

Creates a new deferred 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< AsyncOperation > OpenServiceBroker.Instances.ServiceInstanceDeferredEndpoint.DeprovisionAsync ( string?  serviceId = null,
string?  planId = null 
)
inline

Deprovisions/deletes 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.
Returns
A potentially deferred (asynchronous) operation. If AsyncOperation.Completed is false, start polling LastOperation.
Exceptions
GoneExceptionThe instance does not exist (anymore).

Implements OpenServiceBroker.Instances.IServiceInstanceDeferredEndpoint.

◆ LastOperation()

IPollingEndpoint< LastOperationResource > OpenServiceBroker.Instances.ServiceInstanceDeferredEndpoint.LastOperation ( string?  serviceId = null,
string?  planId = null,
string?  operation = null 
)

Provides an endpoint to obtain the state of the last requested deferred (asynchronous) operation.

Parameters
serviceIdIf present, it MUST be the ID of the service being used.
planIdIf present, it MUST be the ID of the plan for the Service Instance. If this endpoint is being polled as a result of changing the plan through a Service Instance Update, the ID of the plan prior to the update MUST be used.
operationA Service Broker-provided identifier for the operation. When a value for operation is included with deferred (asynchronous) responses for Provision, Update, and Deprovision requests, the Platform MUST provide the same value using this query parameter. If present, MUST be a non-empty string.

Implements OpenServiceBroker.Instances.IServiceInstanceDeferredEndpoint.

◆ ProvisionAsync()

async Task< ServiceInstanceAsyncOperation > OpenServiceBroker.Instances.ServiceInstanceDeferredEndpoint.ProvisionAsync ( ServiceInstanceProvisionRequest  request)
inline

Provisions the Service Instance.

Parameters
requestParameters for the requested Service Instance provision.
Returns
A potentially deferred (asynchronous) operation. If AsyncOperation.Completed is false, start polling LastOperation.
Exceptions
ConflictExceptionAn instance with the same id already exists but with different attributes.

Implements OpenServiceBroker.Instances.IServiceInstanceDeferredEndpoint.

◆ UpdateAsync()

async Task< ServiceInstanceAsyncOperation > OpenServiceBroker.Instances.ServiceInstanceDeferredEndpoint.UpdateAsync ( ServiceInstanceUpdateRequest  request)
inline

Updates the Service Instance.

Parameters
requestParameters for the requested Service Instance update.
Returns
A potentially deferred (asynchronous) operation. If AsyncOperation.Completed is false, start polling LastOperation.
Exceptions
BrokerExceptionThe requested change is not supported.

Implements OpenServiceBroker.Instances.IServiceInstanceDeferredEndpoint.


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