org.springframework.cloud.servicebroker.model.instance

Class GetServiceInstanceResponse.GetServiceInstanceResponseBuilder

java.lang.Object

org.springframework.cloud.servicebroker.model.instance.GetServiceInstanceResponse.GetServiceInstanceResponseBuilder

Enclosing class:

GetServiceInstanceResponse

public static final class GetServiceInstanceResponse.GetServiceInstanceResponseBuilder
extends Object

Provides a fluent API for constructing a GetServiceInstanceResponse.

Method Summary

Modifier and Type	Method and Description
GetServiceInstanceResponse	build() Construct a GetServiceInstanceResponse from the provided values.
GetServiceInstanceResponse.GetServiceInstanceResponseBuilder	dashboardUrl(String dashboardUrl) Set the URL of a web-based management user interface provided by the service broker for the service instance.
GetServiceInstanceResponse.GetServiceInstanceResponseBuilder	parameters(Map<String,Object> parameters) Add a set of parameters from the provided Map to the parameters as were provided to the service broker at service instance creation.
GetServiceInstanceResponse.GetServiceInstanceResponseBuilder	parameters(String key, Object value) Add a key/value pair to the parameters as were provided to the service broker at service instance creation.
GetServiceInstanceResponse.GetServiceInstanceResponseBuilder	planId(String planId) Set the ID of the plan associated with the service instance.
GetServiceInstanceResponse.GetServiceInstanceResponseBuilder	serviceDefinitionId(String serviceDefinitionId) Set the ID of the service definition associated with the service instance.

Methods inherited from class java.lang.Object

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

Method Detail

serviceDefinitionId

public GetServiceInstanceResponse.GetServiceInstanceResponseBuilder serviceDefinitionId(String serviceDefinitionId)

Set the ID of the service definition associated with the service instance.

This value will set the service_id field in the body of the response to the platform.

Parameters:

serviceDefinitionId - the service definition ID

Returns:

the builder

planId

public GetServiceInstanceResponse.GetServiceInstanceResponseBuilder planId(String planId)

Set the ID of the plan associated with the service instance.

This value will set the plan_id field in the body of the response to the platform.

Parameters:

planId - the plan ID

Returns:

the builder

dashboardUrl

public GetServiceInstanceResponse.GetServiceInstanceResponseBuilder dashboardUrl(String dashboardUrl)

Set the URL of a web-based management user interface provided by the service broker for the service instance. Can be null to indicate that a management dashboard is not provided.

This value will set the dashboard_url field in the body of the response to the platform.

Parameters:

dashboardUrl - the dashboard URL

Returns:

the builder

parameters

public GetServiceInstanceResponse.GetServiceInstanceResponseBuilder parameters(Map<String,Object> parameters)

Add a set of parameters from the provided Map to the parameters as were provided to the service broker at service instance creation.

This value will set the parameters field in the body of the response to the platform

Parameters:

parameters - the parameters Map

Returns:

the builder

parameters

public GetServiceInstanceResponse.GetServiceInstanceResponseBuilder parameters(String key,
                                                                               Object value)

Add a key/value pair to the parameters as were provided to the service broker at service instance creation.

This value will set the parameters field in the body of the response to the platform

Parameters:

key - the parameter key

value - the parameter value

Returns:

the builder

build

public GetServiceInstanceResponse build()

Construct a GetServiceInstanceResponse from the provided values.

Returns:

the newly constructed GetServiceInstanceResponse