Class ServiceBindingDeferredEndpoint

Namespace

OpenServiceBroker.Bindings

Assembly

OpenServiceBroker.Client.dll

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

public class ServiceBindingDeferredEndpoint : ServiceBindingEndpointBase, IServiceBindingDeferredEndpoint, IServiceBindingEndpointBase, IEndpoint

Inheritance

object

EndpointBase

ServiceBrokerEndpointBase

ServiceBindingEndpointBase

ServiceBindingDeferredEndpoint

Implements

IServiceBindingDeferredEndpoint

IServiceBindingEndpointBase

IEndpoint

Inherited Members

ServiceBindingEndpointBase.FetchAsync()

ServiceBrokerEndpointBase.GetDeleteUri(string, string)

ServiceBrokerEndpointBase.ParseDeferredResponseAsync(HttpResponseMessage)

ServiceBrokerEndpointBase.ParseDeferredResponseAsync<TComplete, TDeferred>(HttpResponseMessage)

ServiceBrokerEndpointBase.FromContentAsync<T>(HttpResponseMessage)

EndpointBase.HandleAsync(Func<Task<HttpResponseMessage>>, string)

EndpointBase.FinalizeAsync(Func<Task<HttpResponseMessage>>, string)

EndpointBase.StartActivity(string)

EndpointBase.SetDefaultLink(string, string)

EndpointBase.SetDefaultLinkTemplate(string, string)

EndpointBase.GetLinks(string)

EndpointBase.Link(string)

EndpointBase.GetLinkTemplate(string)

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

EndpointBase.LinkTemplate(string, object)

EndpointBase.HandleCapabilities(HttpResponseMessage)

EndpointBase.IsMethodAllowed(HttpMethod)

EndpointBase.ToString()

EndpointBase.GetConstructor<TEndpoint>()

EndpointBase.Uri

EndpointBase.HttpClient

EndpointBase.Serializers

EndpointBase.Serializer

EndpointBase.ErrorHandler

EndpointBase.LinkExtractor

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

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

Constructors

ServiceBindingDeferredEndpoint(IEndpoint, Uri)

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

public ServiceBindingDeferredEndpoint(IEndpoint referrer, Uri relativeUri)

Parameters

referrer IEndpoint

The endpoint used to navigate to this one.

relativeUri Uri

The URI of this endpoint relative to the referrer's.

Methods

BindAsync(ServiceBindingRequest)

Generates the Service Binding.

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

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

public 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).