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

Class CreateServiceInstanceBindingRequest

java.lang.Object
org.springframework.cloud.servicebroker.model.ServiceBrokerRequest
org.springframework.cloud.servicebroker.model.AsyncServiceBrokerRequest
org.springframework.cloud.servicebroker.model.instance.AsyncParameterizedServiceInstanceRequest
org.springframework.cloud.servicebroker.model.binding.CreateServiceInstanceBindingRequest
public class CreateServiceInstanceBindingRequest extends AsyncParameterizedServiceInstanceRequest
Details of a request to create 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:
S Greenberg, Scott Frederick, Roy Clarkson
See Also:

  • Constructor Details

    • CreateServiceInstanceBindingRequest

      public CreateServiceInstanceBindingRequest()
      Construct a new CreateServiceInstanceBindingRequest.

    • CreateServiceInstanceBindingRequest

      public CreateServiceInstanceBindingRequest(String serviceInstanceId, String serviceDefinitionId, String planId, String bindingId, ServiceDefinition serviceDefinition, Plan plan, boolean asyncAccepted, BindResource bindResource, Map<String,Object> parameters, Context context, String platformInstanceId, String apiInfoLocation, Context originatingIdentity, String requestIdentity)
      Construct a new CreateServiceInstanceBindingRequest.
      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
      asyncAccepted - does the platform accept asynchronous requests
      bindResource - the binding resource
      parameters - the parameters
      context - the context
      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

    • getServiceInstanceId

      public String getServiceInstanceId()
      Get the ID of the service instance associated with the binding. This value is assigned by the platform. It must be unique within the platform and can be used to correlate any resources associated with the service instance.

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

      Returns:
      the service instance ID

    • setServiceInstanceId

      public void setServiceInstanceId(String serviceInstanceId)
      This method is intended to be used internally only; use builder() to construct an object of this type and set all field values.
      Parameters:
      serviceInstanceId - the service instance ID associated with the binding

    • getBindingId

      public String getBindingId()
      Get the ID of the service binding to create. This value is assigned by the platform. It must be unique within the platform and can be used to correlate any resources associated with the service binding.

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

      Returns:
      the service instance ID

    • setBindingId

      public void setBindingId(String bindingId)
      This method is intended to be used internally only; use builder() to construct an object of this type and set all field values.
      Parameters:
      bindingId - the ID of the service binding to create

    • 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

    • getAppGuid

      @Deprecated public String getAppGuid()
      Deprecated.
      getBindResource() provides platform-neutral access to binding resource details
      Get the GUID of the application the service instance will be bound to. Will be provided when users bind applications to service instances, or null if an application is not being bound.

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

      Returns:
      the app GUID

    • getBindResource

      public BindResource getBindResource()
      Get any details about the resource the binding is being created for (e.g. an application).

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

      Returns:
      the binding resource details

    • 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

    • setServiceDefinition

      public void setServiceDefinition(ServiceDefinition serviceDefinition)
      This method is intended to be used internally only; use builder() to construct an object of this type and set all field values.
      Parameters:
      serviceDefinition - the service definition of the service instance associated with the binding

    • 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

    • setPlan

      public void setPlan(Plan plan)
      This method is intended to be used internally only; use builder() to construct an object of this type and set all field values.
      Parameters:
      plan - the plan of the service instance associated with the binding

    • builder

      public static CreateServiceInstanceBindingRequest.CreateServiceInstanceBindingRequestBuilder builder()
      Create a builder that provides a fluent API for constructing a CreateServiceInstanceBindingRequest.

      This builder is provided to support testing of ServiceInstanceBindingService implementations.

      Returns:
      the builder

    • equals

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

    • canEqual

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

    • hashCode

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

    • toString

      public String toString()
      Overrides:
      toString in class AsyncParameterizedServiceInstanceRequest