Interface IServiceInstanceDeferredEndpoint

Namespace

OpenServiceBroker.Instances

Assembly

OpenServiceBroker.Client.dll

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

public interface IServiceInstanceDeferredEndpoint : IServiceInstanceEndpointBase<IServiceBindingDeferredEndpoint>, IEndpoint

Inherited Members

IServiceInstanceEndpointBase<IServiceBindingDeferredEndpoint>.FetchAsync()

IServiceInstanceEndpointBase<IServiceBindingDeferredEndpoint>.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?)

Deprovisions/deletes the Service Instance.

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

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

A potentially deferred (asynchronous) operation. If Completed is false, start polling LastOperation(string?, string?, string?).

Exceptions

GoneException

The instance does not exist (anymore).

LastOperation(string?, string?, string?)

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

IPollingEndpoint<LastOperationResource> LastOperation(string? serviceId = null, string? planId = null, string? operation = null)

Parameters

serviceId string

If present, it MUST be the ID of the service being used.

planId string

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

operation string

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

Returns

IPollingEndpoint<LastOperationResource>

ProvisionAsync(ServiceInstanceProvisionRequest)

Provisions the Service Instance.

Task<ServiceInstanceAsyncOperation> ProvisionAsync(ServiceInstanceProvisionRequest request)

Parameters

request ServiceInstanceProvisionRequest

Parameters for the requested Service Instance provision.

Returns

Task<ServiceInstanceAsyncOperation>

A potentially deferred (asynchronous) operation. If Completed is false, start polling LastOperation(string?, string?, string?).

Exceptions

ConflictException

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

UpdateAsync(ServiceInstanceUpdateRequest)

Updates the Service Instance.

Task<ServiceInstanceAsyncOperation> UpdateAsync(ServiceInstanceUpdateRequest request)

Parameters

request ServiceInstanceUpdateRequest

Parameters for the requested Service Instance update.

Returns

Task<ServiceInstanceAsyncOperation>

A potentially deferred (asynchronous) operation. If Completed is false, start polling LastOperation(string?, string?, string?).

Exceptions

BrokerException

The requested change is not supported.