public class ServiceDefinition extends Object
Modifier and Type | Class and Description |
---|---|
static class |
ServiceDefinition.ServiceDefinitionBuilder
Provides a fluent API for constructing a ServiceDefinition.
|
Constructor and Description |
---|
ServiceDefinition()
Construct a new
ServiceDefinition |
ServiceDefinition(String id,
String name,
String description,
boolean bindable,
Boolean planUpdateable,
Boolean instancesRetrievable,
Boolean bindingsRetrievable,
Boolean allowContextUpdates,
List<Plan> plans,
List<String> tags,
Map<String,Object> metadata,
List<String> requires,
DashboardClient dashboardClient)
Construct a new
ServiceDefinition |
Modifier and Type | Method and Description |
---|---|
static ServiceDefinition.ServiceDefinitionBuilder |
builder()
Create a builder that provides a fluent API for constructing a ServiceDefinition.
|
boolean |
equals(Object o) |
DashboardClient |
getDashboardClient()
Data necessary to activate the Dashboard SSO feature for this service.
|
String |
getDescription()
A user-friendly short description of the service that will appear in the catalog.
|
String |
getId()
An identifier used to correlate this service in future requests to the catalog.
|
Map<String,Object> |
getMetadata()
A map of metadata to further describe a service offering.
|
String |
getName()
A CLI-friendly name of the service that will appear in the catalog.
|
List<Plan> |
getPlans()
A list of plans for this service.
|
List<String> |
getRequires()
A list of permissions that the user would have to give the service, if they provision it.
|
List<String> |
getTags()
A list of tags to aid in categorizing and classifying services with similar characteristics.
|
int |
hashCode() |
Boolean |
isAllowContextUpdates()
Indicates whether a service instance supports update requests when contextual data for the service instance in
the platform changes.
|
boolean |
isBindable()
Indicates whether the service can be bound to applications.
|
Boolean |
isBindingsRetrievable()
Indicates whether the service broker supports retrieving service bindings.
|
Boolean |
isInstancesRetrievable()
Indicates whether the service broker supports retrieving service instances.
|
Boolean |
isPlanUpdateable()
Indicates whether the service supports requests to update instances to use a different plan from the one used to
provision a service instance.
|
String |
toString() |
public ServiceDefinition()
ServiceDefinition
public ServiceDefinition(String id, String name, String description, boolean bindable, Boolean planUpdateable, Boolean instancesRetrievable, Boolean bindingsRetrievable, Boolean allowContextUpdates, List<Plan> plans, List<String> tags, Map<String,Object> metadata, List<String> requires, DashboardClient dashboardClient)
ServiceDefinition
id
- the service IDname
- the service namedescription
- the service descriptionbindable
- true if the service may be boundplanUpdateable
- true if the plan may be updatedinstancesRetrievable
- true if the service instances may be retrievedbindingsRetrievable
- true if the service bindings may be retrievedallowContextUpdates
- true if the service instance supports context updatesplans
- the service planstags
- the tagsmetadata
- the service metadatarequires
- the required permissionsdashboardClient
- the service dashboard URIpublic String getId()
public String getName()
public String getDescription()
public boolean isBindable()
public Boolean isPlanUpdateable()
public Boolean isInstancesRetrievable()
public Boolean isBindingsRetrievable()
public Boolean isAllowContextUpdates()
public List<String> getTags()
public Map<String,Object> getMetadata()
public List<String> getRequires()
supported permissions
public DashboardClient getDashboardClient()
public static ServiceDefinition.ServiceDefinitionBuilder builder()