org.springframework.cloud.servicebroker.model.catalog

Class ServiceDefinition.ServiceDefinitionBuilder

java.lang.Object

org.springframework.cloud.servicebroker.model.catalog.ServiceDefinition.ServiceDefinitionBuilder

Enclosing class:

ServiceDefinition

public static final class ServiceDefinition.ServiceDefinitionBuilder
extends Object

Provides a fluent API for constructing a ServiceDefinition.

Method Summary

Modifier and Type	Method and Description
ServiceDefinition.ServiceDefinitionBuilder	allowContextUpdates(Boolean allowContextUpdates) Indicates whether the service instance supports contextual updates.
ServiceDefinition.ServiceDefinitionBuilder	bindable(boolean bindable) Indicates whether the service can be bound to applications.
ServiceDefinition.ServiceDefinitionBuilder	bindingsRetrievable(Boolean bindingsRetrievable) Indicates whether the service broker supports retrieving service bindings.
ServiceDefinition	build() Construct a ServiceDefinition from the provided values.
ServiceDefinition.ServiceDefinitionBuilder	dashboardClient(DashboardClient dashboardClient) Data necessary to activate the Dashboard SSO feature for this service.
ServiceDefinition.ServiceDefinitionBuilder	description(String description) A user-friendly short description of the service that will appear in the catalog.
ServiceDefinition.ServiceDefinitionBuilder	id(String id) An identifier used to correlate this service in future requests to the catalog.
ServiceDefinition.ServiceDefinitionBuilder	instancesRetrievable(Boolean instancesRetrievable) Indicates whether the service broker supports retrieving service instances.
ServiceDefinition.ServiceDefinitionBuilder	metadata(Map<String,Object> metadata) A map of metadata to further describe a service offering.
ServiceDefinition.ServiceDefinitionBuilder	metadata(String key, Object value) A key/value pair to add to the map of metadata to further describe a service offering.
ServiceDefinition.ServiceDefinitionBuilder	name(String name) A CLI-friendly name of the service that will appear in the catalog.
ServiceDefinition.ServiceDefinitionBuilder	plans(List<Plan> plans) A list of plans for this service.
ServiceDefinition.ServiceDefinitionBuilder	plans(Plan... plans) A list of plans for this service.
ServiceDefinition.ServiceDefinitionBuilder	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.
ServiceDefinition.ServiceDefinitionBuilder	requires(List<String> requires) A list of permissions that the user would have to give the service, if they provision it.
ServiceDefinition.ServiceDefinitionBuilder	requires(ServiceDefinitionRequires... requires) A list of permissions that the user would have to give the service, if they provision it.
ServiceDefinition.ServiceDefinitionBuilder	requires(String... requires) A list of permissions that the user would have to give the service, if they provision it.
ServiceDefinition.ServiceDefinitionBuilder	tags(List<String> tags) A list of tags to aid in categorizing and classifying services with similar characteristics.
ServiceDefinition.ServiceDefinitionBuilder	tags(String... tags) A list of tags to aid in categorizing and classifying services with similar characteristics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

id

public ServiceDefinition.ServiceDefinitionBuilder id(String 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

public ServiceDefinition.ServiceDefinitionBuilder name(String 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

public ServiceDefinition.ServiceDefinitionBuilder description(String 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

public ServiceDefinition.ServiceDefinitionBuilder bindable(boolean bindable)

Indicates whether the service can be bound to applications.

Parameters:

bindable - true if the service may be bound

Returns:

the binder instance

planUpdateable

public ServiceDefinition.ServiceDefinitionBuilder 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.

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

public ServiceDefinition.ServiceDefinitionBuilder bindingsRetrievable(Boolean 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

public ServiceDefinition.ServiceDefinitionBuilder allowContextUpdates(Boolean allowContextUpdates)

Indicates whether the service instance supports contextual updates.

Parameters:

allowContextUpdates - true if the service instance supports context updates

Returns:

the builder

plans

public ServiceDefinition.ServiceDefinitionBuilder plans(Plan... plans)

A list of plans for this service.

Parameters:

plans - the service plans

Returns:

the binder instance

plans

public ServiceDefinition.ServiceDefinitionBuilder plans(List<Plan> plans)

A list of plans for this service.

Parameters:

plans - the service plans

Returns:

the binder instance

tags

public ServiceDefinition.ServiceDefinitionBuilder tags(String... tags)

A list of tags to aid in categorizing and classifying services with similar characteristics.

Parameters:

tags - the tags

Returns:

the binder instance

tags

public ServiceDefinition.ServiceDefinitionBuilder tags(List<String> tags)

A list of tags to aid in categorizing and classifying services with similar characteristics.

Parameters:

tags - the tags

Returns:

the binder instance

metadata

public ServiceDefinition.ServiceDefinitionBuilder metadata(Map<String,Object> metadata)

A map of metadata to further describe a service offering.

Parameters:

metadata - the service metadata

Returns:

the binder instance

metadata

public ServiceDefinition.ServiceDefinitionBuilder metadata(String key,
                                                           Object value)

A key/value pair to add to the map of metadata to further describe a service offering.

Parameters:

key - the unique key

value - the value

Returns:

the binder instance

requires

public ServiceDefinition.ServiceDefinitionBuilder requires(String... 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:

supported permissions

requires

public ServiceDefinition.ServiceDefinitionBuilder requires(List<String> 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:

supported permissions

requires

public ServiceDefinition.ServiceDefinitionBuilder requires(ServiceDefinitionRequires... 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:

supported permissions

dashboardClient

public ServiceDefinition.ServiceDefinitionBuilder dashboardClient(DashboardClient dashboardClient)

Data necessary to activate the Dashboard SSO feature for this service.

Parameters:

dashboardClient - the service dashboard URI

Returns:

the binder instance

build

public ServiceDefinition build()

Construct a ServiceDefinition from the provided values.

Returns:

the newly constructed ServiceDefinition