Package org.springframework.cloud.servicebroker.model.instance

Class CreateServiceInstanceRequest

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.instance.CreateServiceInstanceRequest
public class CreateServiceInstanceRequest extends AsyncParameterizedServiceInstanceRequest
Details of a request to create a new service instance.

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

    • CreateServiceInstanceRequest

      public CreateServiceInstanceRequest()
      Construct a new CreateServiceInstanceRequest.

    • CreateServiceInstanceRequest

      public CreateServiceInstanceRequest(String serviceDefinitionId, String serviceInstanceId, String planId, ServiceDefinition serviceDefinition, Plan plan, Map<String,Object> parameters, Context context, boolean asyncAccepted, String platformInstanceId, String apiInfoLocation, Context originatingIdentity, String requestIdentity, MaintenanceInfo maintenanceInfo)
      Construct a new CreateServiceInstanceRequest.
      Parameters:
      serviceDefinitionId - the service definition ID
      serviceInstanceId - the service instance ID
      planId - the plan ID
      serviceDefinition - the service definition
      plan - the plan
      parameters - the parameters
      context - the context
      asyncAccepted - 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
      maintenanceInfo - maintenance info sent by the platform

  • Method Details

    • getServiceInstanceId

      public String getServiceInstanceId()
      Get the ID of the service instance 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 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 to create

    • getServiceDefinitionId

      public String getServiceDefinitionId()
      Get the ID of the service definition for to the service instance to create. 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 to create. 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

    • getOrganizationGuid

      @Deprecated public String getOrganizationGuid()
      Deprecated.
      AsyncParameterizedServiceInstanceRequest.getContext() provides platform-neutral access to platform context details
      Get the GUID of the Cloud Foundry organization that the service instance is being created in.

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

      Returns:
      the organization GUID

    • getSpaceGuid

      @Deprecated public String getSpaceGuid()
      Deprecated.
      AsyncParameterizedServiceInstanceRequest.getContext() provides platform-neutral access to platform context details
      Get the GUID of the Cloud Foundry space that the service instance is being created in.

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

      Returns:
      the space GUID

    • getSpaceGuidToSerialize

      protected String getSpaceGuidToSerialize()
      Determine the space GUID.
      Returns:
      the space GUID

    • getOrganizationGuidToSerialize

      protected String getOrganizationGuidToSerialize()
      Determine the organization GUID.
      Returns:
      the organization GUID

    • getServiceDefinition

      public ServiceDefinition getServiceDefinition()
      Get the service definition of the service to create.

      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 to create

    • getPlan

      public Plan getPlan()
      Get the plan of the service to create

      The plan is retrieved from the Catalog as a convenience.

      Returns:
      the plan

    • setPlan

      public void setPlan(Plan plan)
      For internal use only. use builder() to construct an object of this type and set all field values.
      Parameters:
      plan - the plan of the service to create

    • getMaintenanceInfo

      public MaintenanceInfo getMaintenanceInfo()
      Get the maintenance info of the service instance to create. This value is assigned by the platform.

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

      Returns:
      a MaintenanceInfo or null if none was provided

    • builder

      public static CreateServiceInstanceRequest.CreateServiceInstanceRequestBuilder builder()
      Create a builder that provides a fluent API for constructing a CreateServiceInstanceRequest.

      This builder is provided to support testing of ServiceInstanceService implementations.

      Returns:
      the builder

    • equals

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

    • canEqual

      public 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