Package org.springframework.cloud.servicebroker.model.catalog

Class Plan

java.lang.Object
org.springframework.cloud.servicebroker.model.catalog.Plan
public class Plan extends Object
A service plan available for a ServiceDefinition.
Author:
S Greenberg, Scott Frederick, Roy Clarkson
See Also:

  • Constructor Details

    • Plan

      public Plan()
      Construct a new Plan.

    • Plan

      public Plan(String id, String name, String description, Map<String,Object> metadata, Boolean free, Boolean bindable, Boolean planUpdateable, Schemas schemas, Integer maximumPollingDuration, MaintenanceInfo maintenanceInfo)
      Construct a new Plan.
      Parameters:
      id - the plan ID
      name - the plan name
      description - the plan description
      metadata - the plan metadata
      free - true if the plan has no cost
      bindable - true if the service with this plan may be bound
      planUpdateable - true if the plan may be updated
      schemas - the plan schemas
      maximumPollingDuration - the maximum polling duration in seconds
      maintenanceInfo - the maintentance information

  • Method Details

    • getId

      public String getId()
      An identifier used to correlate this plan in future requests to the catalog. This must be unique within the platform. Using a GUID is recommended.
      Returns:
      the plan ID

    • getName

      public String getName()
      A CLI-friendly name of the plan that will appear in the catalog. The value should be all lowercase, with no spaces.
      Returns:
      the plan name

    • getDescription

      public String getDescription()
      A user-friendly short description of the plan that will appear in the catalog.
      Returns:
      the plan description

    • getMetadata

      public Map<String,Object> getMetadata()
      A map of metadata to further describe a service plan.
      Returns:
      the plan metadata
      See Also:

    • isFree

      public Boolean isFree()
      Indicates whether the plan can be limited by the non_basic_services_allowed field in a platform quota.
      Returns:
      true if the plan has no cost

    • isBindable

      public Boolean isBindable()
      Indicates whether the service with this plan can be bound to applications. This is an optional field. If the value is null, the field will be omitted from the serialized JSON.
      Returns:
      true if the service with this plan may be bound

    • isPlanUpdateable

      public Boolean isPlanUpdateable()
      Whether the Plan supports upgrade/downgrade/sidegrade to another version. This field is OPTIONAL. If specified, this takes precedence over the Service Offering's plan_updateable field. If not specified, the default is derived from the Service Offering. If the value is null, the field will be omitted from the serialized JSON.
      Returns:
      true if the plan may be updated

    • getSchemas

      public Schemas getSchemas()
      The schemas for this plan.
      Returns:
      the plan schemas

    • getMaximumPollingDuration

      public Integer getMaximumPollingDuration()
      A duration, in seconds, that the Platform SHOULD use as the Service's maximum polling duration. If the maximum polling duration is reached, the platform should cease polling and the operation state MUST be considered failed. If the value is null, the field will be omitted from the serialized JSON.
      Returns:
      the maximum polling duration

    • getMaintenanceInfo

      public MaintenanceInfo getMaintenanceInfo()
      Maintenance information for a Service Instance which is provisioned using the Service Plan. If provided, a version string MUST be provided and platforms MAY use this when Provisioning or Updating a Service Instance.
      Returns:
      the maintenance info

    • builder

      public static Plan.PlanBuilder builder()
      Create a builder that provides a fluent API for constructing a Plan.
      Returns:
      the builder

    • equals

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

    • hashCode

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

    • toString

      public String toString()
      Overrides:
      toString in class Object