OpenServiceBroker for .NET 0.4.3
client and a server .NET library for the Open Service Broker API specification
OpenServiceBroker.LastOperationEndpoint Class Reference

An endpoint to obtain the state of a deferred (asynchronous) operation. More...

Inheritance diagram for OpenServiceBroker.LastOperationEndpoint:
TypedRest.Endpoints.Reactive.PollingEndpoint< LastOperationResource > TypedRest::Endpoints::Generic::ElementEndpoint< TEntity > TypedRest::Endpoints::Reactive::IPollingEndpoint< out TEntity > TypedRest::Endpoints::Generic::CachingEndpointBase TypedRest::Endpoints::Generic::IElementEndpoint< TEntity > TypedRest::Endpoints::Generic::IElementEndpoint< TEntity > TypedRest::Endpoints::EndpointBase TypedRest::Endpoints::ICachingEndpoint TypedRest::Endpoints::IEndpoint TypedRest::Endpoints::IEndpoint TypedRest::Endpoints::IEndpoint TypedRest::Endpoints::IEndpoint

Public Member Functions

 LastOperationEndpoint (IEndpoint referrer, string? serviceId=null, string? planId=null, string? operation=null)
 Creates a new last operation endpoint. More...
 
- Public Member Functions inherited from TypedRest.Endpoints.Reactive.PollingEndpoint< LastOperationResource >
 PollingEndpoint (IEndpoint referrer, Uri relativeUri, Predicate< LastOperationResource >? endCondition=null)
 
 PollingEndpoint (IEndpoint referrer, string relativeUri, Predicate< LastOperationResource >? endCondition=null)
 
- Public Member Functions inherited from TypedRest::Endpoints::Generic::ElementEndpoint< TEntity >
 ElementEndpoint (IEndpoint referrer, Uri relativeUri)
 
 ElementEndpoint (IEndpoint referrer, string relativeUri)
 
- Public Member Functions inherited from TypedRest::Endpoints::EndpointBase
void SetDefaultLink (string rel, string? href)
 
void SetDefaultLinkTemplate (string rel, string? href)
 
IReadOnlyList<(Uri uri, string? title)> GetLinks (string rel)
 
Uri Link (string rel)
 
UriTemplate GetLinkTemplate (string rel)
 
Uri LinkTemplate (string rel, IDictionary< string, object > variables)
 
Uri LinkTemplate (string rel, object variables)
 
- Public Member Functions inherited from TypedRest::Endpoints::Generic::IElementEndpoint< TEntity >
Task< bool > ExistsAsync (CancellationToken cancellationToken=default)
 
Task DeleteAsync (CancellationToken cancellationToken=default)
 
Task< TEntity > ReadAsync (CancellationToken cancellationToken=default)
 
Task< TEntity?> SetAsync (TEntity entity, CancellationToken cancellationToken=default)
 
Task< TEntity?> MergeAsync (TEntity entity, CancellationToken cancellationToken=default)
 
Task< TEntity?> UpdateAsync (Action< TEntity > updateAction, int maxRetries=3, CancellationToken cancellationToken=default)
 
Task< TEntity?> UpdateAsync (Action< JsonPatchDocument< TEntity > > patchAction, int maxRetries=3, CancellationToken cancellationToken=default)
 
- Public Member Functions inherited from TypedRest::Endpoints::Reactive::IPollingEndpoint< out TEntity >
IObservable< TEntity > GetObservable ()
 

Additional Inherited Members

- Protected Member Functions inherited from TypedRest.Endpoints.Reactive.PollingEndpoint< LastOperationResource >
override async Task< HttpResponseMessage > HandleAsync (Func< Task< HttpResponseMessage > > request, [CallerMemberName] string caller="unknown")
 
- Protected Member Functions inherited from TypedRest::Endpoints::Generic::CachingEndpointBase
 CachingEndpointBase (IEndpoint referrer, Uri relativeUri)
 
 CachingEndpointBase (IEndpoint referrer, string relativeUri)
 
async Task< HttpContent > GetContentAsync (CancellationToken cancellationToken,[CallerMemberName] string caller="unknown")
 
async Task< HttpResponseMessage > PutContentAsync (HttpContent content, CancellationToken cancellationToken,[CallerMemberName] string caller="unknown")
 
async Task< HttpResponseMessage > DeleteContentAsync (CancellationToken cancellationToken,[CallerMemberName] string caller="unknown")
 
- Protected Member Functions inherited from TypedRest::Endpoints::EndpointBase
 EndpointBase (Uri uri, HttpClient httpClient, MediaTypeFormatter serializer, IErrorHandler errorHandler, ILinkExtractor linkExtractor)
 
 EndpointBase (IEndpoint referrer, Uri relativeUri)
 
 EndpointBase (IEndpoint referrer, string relativeUri)
 
Activity? StartActivity ([CallerMemberName] string caller="unknown")
 
virtual void HandleCapabilities (HttpResponseMessage response)
 
bool? IsMethodAllowed (HttpMethod method)
 
- Static Protected Member Functions inherited from TypedRest::Endpoints::EndpointBase
static Func< IEndpoint, Uri, TEndpoint > GetConstructor ()
 
- Properties inherited from TypedRest::Endpoints::IEndpoint
Uri Uri
 
HttpClient HttpClient
 
MediaTypeFormatter Serializer
 
IErrorHandler ErrorHandler
 
ILinkExtractor LinkExtractor
 
- Properties inherited from TypedRest::Endpoints::ICachingEndpoint
ResponseCache? ResponseCache
 
- Properties inherited from TypedRest::Endpoints::Generic::IElementEndpoint< TEntity >
bool? DeleteAllowed
 
TEntity? Response
 
bool? SetAllowed
 
bool? MergeAllowed
 
- Properties inherited from TypedRest::Endpoints::Reactive::IPollingEndpoint< out TEntity >
TimeSpan PollingInterval
 

Detailed Description

An endpoint to obtain the state of a deferred (asynchronous) operation.

Constructor & Destructor Documentation

◆ LastOperationEndpoint()

OpenServiceBroker.LastOperationEndpoint.LastOperationEndpoint ( IEndpoint  referrer,
string?  serviceId = null,
string?  planId = null,
string?  operation = null 
)
inline

Creates a new last operation endpoint.

Parameters
referrerThe endpoint used to navigate to this one.
serviceIdIf present, it MUST be the ID of the service being used.
planIdIf 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.
operationA Service Broker-provided identifier for the operation. When a value for operation is included with 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.

The documentation for this class was generated from the following file: