Interface IServiceBindingDeferredEndpoint

Namespace

OpenServiceBroker.Bindings

Assembly

OpenServiceBroker.Client.dll

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

public interface IServiceBindingDeferredEndpoint : IServiceBindingEndpointBase, IEndpoint

Inherited Members

IServiceBindingEndpointBase.FetchAsync()

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

BindAsync(ServiceBindingRequest)

Generates the Service Binding.

Task<ServiceBindingAsyncOperation> BindAsync(ServiceBindingRequest request)

Parameters

request ServiceBindingRequest

Parameters for the requested Service Binding.

Returns

Task<ServiceBindingAsyncOperation>

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

Exceptions

ConflictException

A binding with the same id already exists but with different attributes.

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>

UnbindAsync(string, string)

Unbinds/deletes the Service Binding.

Task<AsyncOperation> UnbindAsync(string serviceId, string planId)

Parameters

serviceId string

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

planId string

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

Returns

Task<AsyncOperation>

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

Exceptions

GoneException

The binding does not exist (anymore).