Class ServiceDefinition.ServiceDefinitionBuilder
java.lang.Object
org.springframework.cloud.servicebroker.model.catalog.ServiceDefinition.ServiceDefinitionBuilder
- Enclosing class:
- ServiceDefinition
Provides a fluent API for constructing a ServiceDefinition.
-
Method Summary
Modifier and TypeMethodDescriptionallowContextUpdates
(Boolean allowContextUpdates) Indicates whether the service instance supports contextual updates.bindable
(boolean bindable) Indicates whether the service can be bound to applications.bindingsRetrievable
(Boolean bindingsRetrievable) Indicates whether the service broker supports retrieving service bindings.build()
Construct aServiceDefinition
from the provided values.dashboardClient
(DashboardClient dashboardClient) Data necessary to activate the Dashboard SSO feature for this service.description
(String description) A user-friendly short description of the service that will appear in the catalog.An identifier used to correlate this service in future requests to the catalog.instancesRetrievable
(Boolean instancesRetrievable) Indicates whether the service broker supports retrieving service instances.A key/value pair to add to the map of metadata to further describe a service offering.A map of metadata to further describe a service offering.A CLI-friendly name of the service that will appear in the catalog.A list of plans for this service.A list of plans for this service.planUpdateable
(Boolean planUpdateable) Indicates whether the service supports requests to update instances to use a different plan from the one used to provision a service instance.A list of permissions that the user would have to give the service, if they provision it.A list of permissions that the user would have to give the service, if they provision it.requires
(ServiceDefinitionRequires... requires) A list of permissions that the user would have to give the service, if they provision it.A list of tags to aid in categorizing and classifying services with similar characteristics.A list of tags to aid in categorizing and classifying services with similar characteristics.
-
Method Details
-
id
An identifier used to correlate this service in future requests to the catalog. This must be unique within the platform. Using a GUID is recommended.- Parameters:
id
- the service ID- Returns:
- the binder instance
-
name
A CLI-friendly name of the service that will appear in the catalog. The value should be all lowercase, with no spaces.- Parameters:
name
- the service name- Returns:
- the binder instance
-
description
A user-friendly short description of the service that will appear in the catalog.- Parameters:
description
- the service description- Returns:
- the binder instance
-
bindable
Indicates whether the service can be bound to applications.- Parameters:
bindable
- true if the service may be bound- Returns:
- the binder instance
-
planUpdateable
Indicates whether the service supports requests to update instances to use a different plan from the one used to provision a service instance.- Parameters:
planUpdateable
- true if the plan may be updated- Returns:
- the binder instance
-
instancesRetrievable
public ServiceDefinition.ServiceDefinitionBuilder instancesRetrievable(Boolean instancesRetrievable) Indicates whether the service broker supports retrieving service instances.- Parameters:
instancesRetrievable
- true if the service instances may be retrieved- Returns:
- the binder instance
-
bindingsRetrievable
Indicates whether the service broker supports retrieving service bindings.- Parameters:
bindingsRetrievable
- true if the service bindings may be retrieved- Returns:
- the binder instance
-
allowContextUpdates
Indicates whether the service instance supports contextual updates.- Parameters:
allowContextUpdates
- true if the service instance supports context updates- Returns:
- the builder
-
plans
A list of plans for this service.- Parameters:
plans
- the service plans- Returns:
- the binder instance
-
plans
A list of plans for this service.- Parameters:
plans
- the service plans- Returns:
- the binder instance
-
tags
A list of tags to aid in categorizing and classifying services with similar characteristics.- Parameters:
tags
- the tags- Returns:
- the binder instance
-
tags
A list of tags to aid in categorizing and classifying services with similar characteristics.- Parameters:
tags
- the tags- Returns:
- the binder instance
-
metadata
A map of metadata to further describe a service offering.- Parameters:
metadata
- the service metadata- Returns:
- the binder instance
-
metadata
A key/value pair to add to the map of metadata to further describe a service offering.- Parameters:
key
- the unique keyvalue
- the value- Returns:
- the binder instance
-
requires
A list of permissions that the user would have to give the service, if they provision it.- Parameters:
requires
- the required permissions- Returns:
- the binder instance
- See Also:
-
requires
A list of permissions that the user would have to give the service, if they provision it.- Parameters:
requires
- the required permissions- Returns:
- the binder instance
- See Also:
-
requires
A list of permissions that the user would have to give the service, if they provision it.- Parameters:
requires
- the required permissions- Returns:
- the binder instance
- See Also:
-
dashboardClient
Data necessary to activate the Dashboard SSO feature for this service.- Parameters:
dashboardClient
- the service dashboard URI- Returns:
- the binder instance
-
build
Construct aServiceDefinition
from the provided values.- Returns:
- the newly constructed ServiceDefinition
-