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

Class Plan.PlanBuilder

java.lang.Object
org.springframework.cloud.servicebroker.model.catalog.Plan.PlanBuilder
Enclosing class:
Plan
public static final class Plan.PlanBuilder extends Object
Provides a fluent API for constructing a Plan.

  • Method Details

    • id

      public Plan.PlanBuilder id(String id)
      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.
      Parameters:
      id - the unique identifier of the plan
      Returns:
      the builder instance

    • name

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

    • description

      public Plan.PlanBuilder description(String description)
      A user-friendly short description of the plan that will appear in the catalog.
      Parameters:
      description - plan description
      Returns:
      the builder instance

    • metadata

      public Plan.PlanBuilder metadata(Map<String,Object> metadata)
      A map of plan metadata to further describe the plan.
      Parameters:
      metadata - plan metadata
      Returns:
      the builder instance
      See Also:

    • metadata

      public Plan.PlanBuilder metadata(String key, Object value)
      A key/value pair to add to the map of plan metadata.
      Parameters:
      key - a unique key
      value - the value
      Returns:
      the builder instance
      See Also:

    • free

      public Plan.PlanBuilder free(Boolean free)
      Whether the plan has a cost associated with it or not.
      Parameters:
      free - true if the plan has no cost
      Returns:
      the builder instance

    • bindable

      public Plan.PlanBuilder bindable(Boolean bindable)
      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.
      Parameters:
      bindable - true if the service with this plan may be bound
      Returns:
      the builder instance

    • planUpdateable

      public Plan.PlanBuilder planUpdateable(Boolean planUpdateable)
      Indicates whether the the plan can be updated. This is an optional field. If the value is null, the field will be omitted from the serialized JSON.
      Parameters:
      planUpdateable - true if the service with this plan may be bound
      Returns:
      the builder instance

    • schemas

      public Plan.PlanBuilder schemas(Schemas schemas)
      The schemas for this plan.
      Parameters:
      schemas - plan schemas
      Returns:
      the builder instance

    • maximumPollingDuration

      public Plan.PlanBuilder maximumPollingDuration(Integer maximumPollingDuration)
      A duration, in seconds, that the Platform SHOULD use as the Service's maximum polling duration. If the value is null, the field will be omitted from the serialized JSON.
      Parameters:
      maximumPollingDuration - the maximum polling duration
      Returns:
      the builder instance

    • maintenanceInfo

      public Plan.PlanBuilder maintenanceInfo(MaintenanceInfo maintenanceInfo)
      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.
      Parameters:
      maintenanceInfo - the maintenanceInfo
      Returns:
      the builder instance

    • build

      public Plan build()
      Construct a Plan from the provided values.
      Returns:
      the newly constructed Plan