Package org.springframework.cloud.servicebroker.model.binding

Class DeleteServiceInstanceBindingRequest

java.lang.Object
org.springframework.cloud.servicebroker.model.ServiceBrokerRequest
org.springframework.cloud.servicebroker.model.AsyncServiceBrokerRequest
org.springframework.cloud.servicebroker.model.binding.DeleteServiceInstanceBindingRequest
public class DeleteServiceInstanceBindingRequest extends AsyncServiceBrokerRequest
Details of a request to delete a service instance binding.

Objects of this type are constructed by the framework from the headers, path variables, query parameters and message body passed to the service broker by the platform.

Author:
K Rujos, Scott Frederick, Roy Clarkson
See Also:

  • Constructor Details

    • DeleteServiceInstanceBindingRequest

      public DeleteServiceInstanceBindingRequest(String serviceInstanceId, String serviceDefinitionId, String planId, String bindingId, ServiceDefinition serviceDefinition, Plan plan, boolean acceptsAsync, String platformInstanceId, String apiInfoLocation, Context originatingIdentity, String requestIdentity)
      Construct a new DeleteServiceInstanceBindingRequest.
      Parameters:
      serviceInstanceId - the service instance ID
      serviceDefinitionId - the service definition ID
      planId - the plan ID
      bindingId - the service binding ID
      serviceDefinition - the service definition
      plan - the plan
      acceptsAsync - does the platform accept asynchronous requests
      platformInstanceId - the platform instance ID
      apiInfoLocation - location of the API info endpoint of the platform instance
      originatingIdentity - identity of the user that initiated the request from the platform
      requestIdentity - identity of the request sent from the platform

  • Method Details

    • isAsyncAccepted

      public boolean isAsyncAccepted()
      Description copied from class: AsyncServiceBrokerRequest
      Get the value indicating whether the platform allows the broker to complete the request asynchronously.

      This value is set from the async_accepted request parameter of the request from the platform.

      A false value indicates that clients do not allow asynchronous processing of requests, a true value indicates that clients do allow asynchronous processing.

      Overrides:
      isAsyncAccepted in class AsyncServiceBrokerRequest
      Returns:
      the boolean value

    • getServiceInstanceId

      public String getServiceInstanceId()
      Get the ID of the service instance associated with the binding.

      This value is set from the :instance_id path element of the request from the platform.

      Returns:
      the service instance ID

    • getBindingId

      public String getBindingId()
      Get the ID of the service binding to delete.

      This value is set from the :binding_id path element of the request from the platform.

      Returns:
      the service instance ID

    • getServiceDefinitionId

      public String getServiceDefinitionId()
      Get the ID of the service definition for the service instance associated with the binding. This will match one of the service definition IDs provided in the Catalog.

      This value is set from the service_id field in the body of the request from the platform

      Returns:
      the service definition ID

    • getPlanId

      public String getPlanId()
      Get the ID of the plan for to the service instance associated with the binding. This will match one of the plan IDs provided in the Catalog within the specified ServiceDefinition.

      This value is set from the plan_id field in the body of the request from the platform.

      Returns:
      the plan ID

    • getServiceDefinition

      public ServiceDefinition getServiceDefinition()
      Get the service definition of the service instance associated with the binding.

      The service definition is retrieved from the Catalog as a convenience.

      Returns:
      the service definition

    • getPlan

      public Plan getPlan()
      Get the plan of the service instance associated with the binding.

      The plan is retrieved from the Catalog as a convenience.

      Returns:
      the plan

    • builder

      public static DeleteServiceInstanceBindingRequest.DeleteServiceInstanceBindingRequestBuilder builder()
      Create a builder that provides a fluent API for constructing a DeleteServiceInstanceBindingRequest.

      This builder is provided to support testing of ServiceInstanceBindingService implementations.

      Returns:
      the builder

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class AsyncServiceBrokerRequest

    • canEqual

      public final boolean canEqual(Object other)
      Description copied from class: ServiceBrokerRequest
      Is another object type compatible with this object.
      Overrides:
      canEqual in class AsyncServiceBrokerRequest
      Parameters:
      other - the other object
      Returns:
      true of compatible

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AsyncServiceBrokerRequest

    • toString

      public String toString()
      Overrides:
      toString in class AsyncServiceBrokerRequest