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

Manages Service Instances with potentially deferred (asynchronous) operations. More...

Inheritance diagram for OpenServiceBroker.Instances.IServiceInstanceDeferred:
OpenServiceBroker.Instances.IServiceInstanceBase

Public Member Functions

Task< ServiceInstanceAsyncOperationProvisionAsync (ServiceInstanceContext context, ServiceInstanceProvisionRequest request)
 Provisions a Service Instance. More...
 
Task< ServiceInstanceAsyncOperationUpdateAsync (ServiceInstanceContext context, ServiceInstanceUpdateRequest request)
 Updates a Service Instance. More...
 
Task< AsyncOperationDeprovisionAsync (ServiceInstanceContext context, string? serviceId=null, string? planId=null)
 Deprovisions/deletes a Service Instance. More...
 
Task< LastOperationResourceGetLastOperationAsync (ServiceInstanceContext context, string? serviceId=null, string? planId=null, string? operation=null)
 Gets the state of the last requested deferred (asynchronous) operation for a Service Instance. More...
 
- Public Member Functions inherited from OpenServiceBroker.Instances.IServiceInstanceBase
Task< ServiceInstanceResourceFetchAsync (string instanceId)
 Fetches a Service Instance. More...
 

Detailed Description

Manages Service Instances with potentially deferred (asynchronous) operations.

Member Function Documentation

◆ DeprovisionAsync()

Task< AsyncOperation > OpenServiceBroker.Instances.IServiceInstanceDeferred.DeprovisionAsync ( ServiceInstanceContext  context,
string?  serviceId = null,
string?  planId = null 
)

Deprovisions/deletes a Service Instance.

Parameters
contextThe id of instance being deleted.
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.
Exceptions
GoneExceptionThe instance does not exist (anymore).

◆ GetLastOperationAsync()

Task< LastOperationResource > OpenServiceBroker.Instances.IServiceInstanceDeferred.GetLastOperationAsync ( ServiceInstanceContext  context,
string?  serviceId = null,
string?  planId = null,
string?  operation = null 
)

Gets the state of the last requested deferred (asynchronous) operation for a Service Instance.

Parameters
contextThe id of instance to find last operation applied to it
serviceIdThe id of the service associated with the instance.
planIdThe id of the plan associated with the instance.
operationThe value provided in AsyncOperation.Operation.
Exceptions
GoneExceptionThe instance requested to be deleted does not exist (anymore).

◆ ProvisionAsync()

Task< ServiceInstanceAsyncOperation > OpenServiceBroker.Instances.IServiceInstanceDeferred.ProvisionAsync ( ServiceInstanceContext  context,
ServiceInstanceProvisionRequest  request 
)

Provisions a Service Instance.

Parameters
contextThe id of instance to provision
requestParameters for the requested Service Instance provision
Returns
A potentially deferred (asynchronous) operation.
Exceptions
ConflictExceptioninstance with the same id already exists but with different attributes

◆ UpdateAsync()

Task< ServiceInstanceAsyncOperation > OpenServiceBroker.Instances.IServiceInstanceDeferred.UpdateAsync ( ServiceInstanceContext  context,
ServiceInstanceUpdateRequest  request 
)

Updates a Service Instance.

Parameters
contextThe id of instance to update.
requestParameters for the requested Service Instance update
Returns
A potentially deferred (asynchronous) operation.
Exceptions
BrokerExceptionThe requested change is not supported.

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