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

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

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

Public Member Functions

Task< ServiceInstanceAsyncOperationProvisionAsync (ServiceInstanceProvisionRequest request)
 Provisions the Service Instance. More...
 
Task< ServiceInstanceAsyncOperationUpdateAsync (ServiceInstanceUpdateRequest request)
 Updates the Service Instance. More...
 
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.IServiceInstanceEndpointBase< IServiceBindingDeferredEndpoint >
Task< ServiceInstanceResourceFetchAsync ()
 Fetches a Service Instance. More...
 

Additional Inherited Members

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

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< AsyncOperation > OpenServiceBroker.Instances.IServiceInstanceDeferredEndpoint.DeprovisionAsync ( string?  serviceId = null,
string?  planId = null 
)

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

Implemented in OpenServiceBroker.Instances.ServiceInstanceDeferredEndpoint.

◆ LastOperation()

IPollingEndpoint< LastOperationResource > OpenServiceBroker.Instances.IServiceInstanceDeferredEndpoint.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.

Implemented in OpenServiceBroker.Instances.ServiceInstanceDeferredEndpoint.

◆ ProvisionAsync()

Task< ServiceInstanceAsyncOperation > OpenServiceBroker.Instances.IServiceInstanceDeferredEndpoint.ProvisionAsync ( ServiceInstanceProvisionRequest  request)

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.

Implemented in OpenServiceBroker.Instances.ServiceInstanceDeferredEndpoint.

◆ UpdateAsync()

Task< ServiceInstanceAsyncOperation > OpenServiceBroker.Instances.IServiceInstanceDeferredEndpoint.UpdateAsync ( ServiceInstanceUpdateRequest  request)

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.

Implemented in OpenServiceBroker.Instances.ServiceInstanceDeferredEndpoint.


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