Interface IServiceInstanceEndpoint

Namespace

OpenServiceBroker.Instances

Assembly

OpenServiceBroker.Client.dll

Represents a specific Service Instance with blocking operations.

public interface IServiceInstanceEndpoint : IServiceInstanceEndpointBase<IServiceBindingEndpoint>, IEndpoint

Inherited Members

IServiceInstanceEndpointBase<IServiceBindingEndpoint>.FetchAsync()

IServiceInstanceEndpointBase<IServiceBindingEndpoint>.ServiceBindings

IEndpoint.GetLinks(string)

IEndpoint.Link(string)

IEndpoint.LinkTemplate(string, IDictionary<string, object>)

IEndpoint.LinkTemplate(string, object)

IEndpoint.Uri

IEndpoint.HttpClient

IEndpoint.Serializers

IEndpoint.ErrorHandler

IEndpoint.LinkExtractor

Extension Methods

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

Remarks

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.

Methods

DeprovisionAsync(string, string)

Deprovision the Service Instance.

Task DeprovisionAsync(string serviceId, string planId)

Parameters

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

Exceptions

GoneException

The instance does not exist (anymore).

ProvisionAsync(ServiceInstanceProvisionRequest)

Provisions the Service Instance.

Task<ServiceInstanceProvision> ProvisionAsync(ServiceInstanceProvisionRequest request)

Parameters

request ServiceInstanceProvisionRequest

Parameters for the requested Service Instance provision.

Returns

Task<ServiceInstanceProvision>

The provisioned instance.

Exceptions

ConflictException

An instance with the same id already exists but with different attributes.

UpdateAsync(ServiceInstanceUpdateRequest)

Updates the Service Instance.

Task UpdateAsync(ServiceInstanceUpdateRequest request)

Parameters

request ServiceInstanceUpdateRequest

Parameters for the requested Service Instance update.

Returns

Task

Exceptions

BrokerException

The requested change is not supported.