public static final class ServiceDefinition.ServiceDefinitionBuilder extends Object
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.
|
public ServiceDefinition.ServiceDefinitionBuilder id(String id)
id
- the service IDpublic ServiceDefinition.ServiceDefinitionBuilder name(String name)
name
- the service namepublic ServiceDefinition.ServiceDefinitionBuilder description(String description)
description
- the service descriptionpublic ServiceDefinition.ServiceDefinitionBuilder bindable(boolean bindable)
bindable
- true if the service may be boundpublic ServiceDefinition.ServiceDefinitionBuilder planUpdateable(Boolean planUpdateable)
planUpdateable
- true if the plan may be updatedpublic ServiceDefinition.ServiceDefinitionBuilder instancesRetrievable(Boolean instancesRetrievable)
instancesRetrievable
- true if the service instances may be retrievedpublic ServiceDefinition.ServiceDefinitionBuilder bindingsRetrievable(Boolean bindingsRetrievable)
bindingsRetrievable
- true if the service bindings may be retrievedpublic ServiceDefinition.ServiceDefinitionBuilder allowContextUpdates(Boolean allowContextUpdates)
allowContextUpdates
- true if the service instance supports context updatespublic ServiceDefinition.ServiceDefinitionBuilder plans(Plan... plans)
plans
- the service planspublic ServiceDefinition.ServiceDefinitionBuilder plans(List<Plan> plans)
plans
- the service planspublic ServiceDefinition.ServiceDefinitionBuilder tags(String... tags)
tags
- the tagspublic ServiceDefinition.ServiceDefinitionBuilder tags(List<String> tags)
tags
- the tagspublic ServiceDefinition.ServiceDefinitionBuilder metadata(Map<String,Object> metadata)
metadata
- the service metadatapublic ServiceDefinition.ServiceDefinitionBuilder metadata(String key, Object value)
key
- the unique keyvalue
- the valuepublic ServiceDefinition.ServiceDefinitionBuilder requires(String... requires)
requires
- the required permissionssupported permissions
public ServiceDefinition.ServiceDefinitionBuilder requires(List<String> requires)
requires
- the required permissionssupported permissions
public ServiceDefinition.ServiceDefinitionBuilder requires(ServiceDefinitionRequires... requires)
requires
- the required permissionssupported permissions
public ServiceDefinition.ServiceDefinitionBuilder dashboardClient(DashboardClient dashboardClient)
dashboardClient
- the service dashboard URIpublic ServiceDefinition build()
ServiceDefinition
from the provided values.