Interface IServiceInstanceDeferred

Namespace

OpenServiceBroker.Instances

Assembly

OpenServiceBroker.Server.dll

Manages Service Instances with potentially deferred (asynchronous) operations.

public interface IServiceInstanceDeferred : IServiceInstanceBase

Inherited Members

IServiceInstanceBase.FetchAsync(string)

Extension Methods

CompletableWithResult.Complete<TCompletable, TResult>(TCompletable, TResult?)

Methods

DeprovisionAsync(ServiceInstanceContext, string?, string?)

Deprovisions/deletes a Service Instance.

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

Parameters

context ServiceInstanceContext

The id of instance being deleted.

serviceId string

The id of the service associated with the instance being deleted.

planId string

The id of the plan associated with the instance being deleted.

Returns

Task<AsyncOperation>

A potentially deferred (asynchronous) operation.

Exceptions

GoneException

The instance does not exist (anymore).

GetLastOperationAsync(ServiceInstanceContext, string?, string?, string?)

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

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

Parameters

context ServiceInstanceContext

The id of instance to find last operation applied to it

serviceId string

The id of the service associated with the instance.

planId string

The id of the plan associated with the instance.

operation string

The value provided in Operation.

Returns

Task<LastOperationResource>

Exceptions

GoneException

The instance requested to be deleted does not exist (anymore).

ProvisionAsync(ServiceInstanceContext, ServiceInstanceProvisionRequest)

Provisions a Service Instance.

Task<ServiceInstanceAsyncOperation> ProvisionAsync(ServiceInstanceContext context, ServiceInstanceProvisionRequest request)

Parameters

context ServiceInstanceContext

The id of instance to provision

request ServiceInstanceProvisionRequest

Parameters for the requested Service Instance provision

Returns

Task<ServiceInstanceAsyncOperation>

A potentially deferred (asynchronous) operation.

Exceptions

ConflictException

instance with the same id already exists but with different attributes

UpdateAsync(ServiceInstanceContext, ServiceInstanceUpdateRequest)

Updates a Service Instance.

Task<ServiceInstanceAsyncOperation> UpdateAsync(ServiceInstanceContext context, ServiceInstanceUpdateRequest request)

Parameters

context ServiceInstanceContext

The id of instance to update.

request ServiceInstanceUpdateRequest

Parameters for the requested Service Instance update

Returns

Task<ServiceInstanceAsyncOperation>

A potentially deferred (asynchronous) operation.

Exceptions

BrokerException

The requested change is not supported.