OpenServiceBroker for .NET 0.4.4
client and a server .NET library for the Open Service Broker API specification
OpenServiceBroker.Instances.ServiceInstancesController Class Reference

Exposes Service Instances. More...

Inheritance diagram for OpenServiceBroker.Instances.ServiceInstancesController:
OpenServiceBroker.BrokerControllerBase< IServiceInstanceBlocking, IServiceInstanceDeferred >

Public Member Functions

 ServiceInstancesController (IServiceProvider provider)
 
Task< IActionResult > Fetch ([FromRoute(Name="instance_id"), Required] string instanceId)
 Fetches a Service Instance. More...
 
Task< IActionResult > Provision ([FromRoute(Name="instance_id"), Required] string instanceId, [FromBody, Required] ServiceInstanceProvisionRequest request, [FromQuery(Name="accepts_incomplete")] bool acceptsIncomplete=false)
 Provisions a Service Instance. More...
 
Task< IActionResult > Update ([FromRoute(Name="instance_id"), Required] string instanceId, [FromBody, Required] ServiceInstanceUpdateRequest request, [FromQuery(Name="accepts_incomplete")] bool acceptsIncomplete=false)
 Updates a Service Instance. More...
 
Task< IActionResult > Deprovision ([FromRoute(Name="instance_id"), Required] string instanceId, [FromQuery(Name="service_id"), Required] string serviceId, [FromQuery(Name="plan_id"), Required] string planId, [FromQuery(Name="accepts_incomplete")] bool acceptsIncomplete=false)
 Deprovisions/deletes a Service Instance. More...
 
Task< IActionResult > GetLastOperation ([FromRoute(Name="instance_id"), Required] string instanceId, [FromQuery(Name="service_id")] string? serviceId=null, [FromQuery(Name="plan_id")] string? planId=null, [FromQuery(Name="operation")] string? operation=null)
 Gets the state of the last requested deferred (asynchronous) operation for a Service Instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from OpenServiceBroker.BrokerControllerBase< IServiceInstanceBlocking, IServiceInstanceDeferred >
 BrokerControllerBase (IServiceProvider provider)
 
async Task< IActionResult > Do (bool acceptsIncomplete, Func< TBlocking, Task< IActionResult > > blocking, Func< TDeferred, Task< IActionResult > > deferred)
 Performs either a blocking or a deferred operation, handling aspects such as API versioning and error serialization. More...
 
new OkObjectResult Ok ()
 Creates an OK response with an empty JSON object in the body.
 
- Properties inherited from OpenServiceBroker.BrokerControllerBase< IServiceInstanceBlocking, IServiceInstanceDeferred >
static ApiVersion SupportedApiVersion [get]
 The latest Open Service Broker API version currently supported.
 
OriginatingIdentity??? OriginatingIdentity [get]
 Describes the identity of the user that initiated a request from the Platform.
 

Detailed Description

Exposes Service Instances.

Member Function Documentation

◆ Deprovision()

Task< IActionResult > OpenServiceBroker.Instances.ServiceInstancesController.Deprovision ( [FromRoute(Name = "instance_id"), Required] string  instanceId,
[FromQuery(Name = "service_id"), Required] string  serviceId,
[FromQuery(Name = "plan_id"), Required] string  planId,
[FromQuery(Name = "accepts_incomplete")] bool  acceptsIncomplete = false 
)
inline

Deprovisions/deletes a Service Instance.

Parameters
instanceIdThe id of instance being deleted.
serviceIdThe id of the service associated with the instance being deleted.
planIdThe id of the plan associated with the instance being deleted.
acceptsIncompleteA value of true indicates that the Platform and its clients support deferred (asynchronous) Service Broker operations. If this parameter is false, and the Service Broker can only handle a request deferred (asynchronously) Errors.AsyncRequiredException is thrown.

<response code="200">The instance was deleted as a result of this request.</response> <response code="202">The instance deletion is in progress. See GetLastOperation.</response> <response code="400">The request is malformed or missing mandatory data.</response> <response code="410">The instance does not exist.</response> <response code="422">The broker only supports asynchronous processing for the requested operation and the request did not include acceptsIncomplete =true.</response>

◆ Fetch()

Task< IActionResult > OpenServiceBroker.Instances.ServiceInstancesController.Fetch ( [FromRoute(Name = "instance_id"), Required] string  instanceId)
inline

Fetches a Service Instance.

Parameters
instanceIdThe id of instance to fetch.

<response code="200"> <response code="404">The instance does not exist or a provisioning operation is still in progress.</response> <response code="422">The instance is being updated and therefore cannot be fetched at this time.</response>

◆ GetLastOperation()

Task< IActionResult > OpenServiceBroker.Instances.ServiceInstancesController.GetLastOperation ( [FromRoute(Name = "instance_id"), Required] string  instanceId,
[FromQuery(Name = "service_id")] string?  serviceId = null,
[FromQuery(Name = "plan_id")] string?  planId = null,
[FromQuery(Name = "operation")] string?  operation = null 
)
inline

Gets the state of the last requested deferred (asynchronous) operation for a Service Instance.

Parameters
instanceIdThe instance id of instance to find last operation applied to it
serviceIdThe id of the service associated with the instance.
planIdThe id of the plan associated with the instance.
operationThe value provided in AsyncOperation.Operation.

<response code="200"> <response code="400">The request is malformed or missing mandatory data.</response> <response code="410">The instance requested to be deleted does not exist (anymore).</response>

◆ Provision()

Task< IActionResult > OpenServiceBroker.Instances.ServiceInstancesController.Provision ( [FromRoute(Name = "instance_id"), Required] string  instanceId,
[FromBody, Required] ServiceInstanceProvisionRequest  request,
[FromQuery(Name = "accepts_incomplete")] bool  acceptsIncomplete = false 
)
inline

Provisions a Service Instance.

Parameters
instanceIdThe id of instance to provision.
requestParameters for the requested Service Instance provision
acceptsIncompleteA value of true indicates that the Platform and its clients support deferred (asynchronous) Service Broker operations. If this parameter is false, and the Service Broker can only handle a request deferred (asynchronously) Errors.AsyncRequiredException is thrown.

<response code="200">The instance already exists, is fully provisioned, and the requested parameters are identical to the existing instance.</response> <response code="201">The instance was provisioned as a result of this request.</response> <response code="202">The instance provisioning is in progress. See GetLastOperation.</response> <response code="400">The request is malformed or missing mandatory data.</response> <response code="409">The instance with the same id already exists but with different attributes.</response> <response code="422">The broker only supports asynchronous processing for the requested operation and the request did not include acceptsIncomplete =true.</response>

◆ Update()

Task< IActionResult > OpenServiceBroker.Instances.ServiceInstancesController.Update ( [FromRoute(Name = "instance_id"), Required] string  instanceId,
[FromBody, Required] ServiceInstanceUpdateRequest  request,
[FromQuery(Name = "accepts_incomplete")] bool  acceptsIncomplete = false 
)
inline

Updates a Service Instance.

Parameters
instanceIdThe instance id of instance to update
requestParameters for the requested Service Instance update
acceptsIncompleteA value of true indicates that the Platform and its clients support deferred (asynchronous) Service Broker operations. If this parameter is false, and the Service Broker can only handle a request deferred (asynchronously) Errors.AsyncRequiredException is thrown.

<response code="200">The request's changes have been applied or have had no effect.</response> <response code="202">The instance update is in progress. See GetLastOperation.</response> <response code="400">The request is malformed or missing mandatory data.</response> <response code="422">The requested change is not supported or the broker only supports asynchronous processing for the requested operation and the request did not include acceptsIncomplete =true.</response>


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