Class Plan.PlanBuilder
java.lang.Object
org.springframework.cloud.servicebroker.model.catalog.Plan.PlanBuilder
- Enclosing class:
- Plan
Provides a fluent API for constructing a Plan.
-
Method Summary
Modifier and TypeMethodDescriptionIndicates whether the service with this plan can be bound to applications.build()Construct aPlanfrom the provided values.description(String description) A user-friendly short description of the plan that will appear in the catalog.Whether the plan has a cost associated with it or notAn identifier used to correlate this plan in future requests to the catalog.maintenanceInfo(MaintenanceInfo maintenanceInfo) Maintenance information for a Service Instance which is provisioned using the Service Plan.maximumPollingDuration(Integer maximumPollingDuration) A duration, in seconds, that the Platform SHOULD use as the Service's maximum polling duration.A key/value pair to add to the map of plan metadataA map of plan metadata to further describe the planA CLI-friendly name of the plan that will appear in the catalog.planUpdateable(Boolean planUpdateable) Indicates whether the the plan can be updated.The schemas for this plan
-
Method Details
-
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
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
A user-friendly short description of the plan that will appear in the catalog.- Parameters:
description- plan description- Returns:
- the builder instance
-
metadata
A map of plan metadata to further describe the plan- Parameters:
metadata- plan metadata- Returns:
- the builder instance
- See Also:
-
metadata
A key/value pair to add to the map of plan metadata- Parameters:
key- a unique keyvalue- the value- Returns:
- the builder instance
- See Also:
-
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
Indicates whether the service with this plan can be bound to applications. This is an optional field. If the value isnull, 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
Indicates whether the the plan can be updated. This is an optional field. If the value isnull, 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
The schemas for this plan- Parameters:
schemas- plan schemas- Returns:
- the builder instance
-
maximumPollingDuration
A duration, in seconds, that the Platform SHOULD use as the Service's maximum polling duration. If the value isnull, the field will be omitted from the serialized JSON.- Parameters:
maximumPollingDuration- the maximum polling duration- Returns:
- the builder instance
-
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
Construct aPlanfrom the provided values.- Returns:
- the newly constructed Plan
-