org.springframework.cloud.servicebroker.model.instance

Class GetServiceInstanceResponse

java.lang.Object

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

public class GetServiceInstanceResponse
extends Object

Details of a response to a request to get the details a service instance.

Objects of this type are constructed by the service broker application, and used to build the response to the platform.

Author:

Scott Frederick

See Also:

Open Service Broker API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetServiceInstanceResponse.GetServiceInstanceResponseBuilder Provides a fluent API for constructing a GetServiceInstanceResponse.

Method Summary

Modifier and Type	Method and Description
static GetServiceInstanceResponse.GetServiceInstanceResponseBuilder	builder() Create a builder that provides a fluent API for constructing a GetServiceInstanceResponse.
boolean	canEqual(Object other)
boolean	equals(Object o)
String	getDashboardUrl() Get the URL of a web-based management user interface for the service instance.
Map<String,Object>	getParameters() Get any parameters provided to the service broker when the service instance was created.
String	getPlanId() Get the ID of the plan associated with the service instance.
String	getServiceDefinitionId() Get the ID of the service definition associated with the service instance.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getServiceDefinitionId

public String getServiceDefinitionId()

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

Returns:

the service definition ID

getPlanId

public String getPlanId()

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

Returns:

the plan ID

getDashboardUrl

public String getDashboardUrl()

Get the URL of a web-based management user interface for the service instance.

Returns:

the dashboard URL, or null if not provided

getParameters

public Map<String,Object> getParameters()

Get any parameters provided to the service broker when the service instance was created.

Returns:

the parameters, or null if parameters were not provided at creation or retrieval of parameters is not supported by the service broker

builder

public static GetServiceInstanceResponse.GetServiceInstanceResponseBuilder builder()

Create a builder that provides a fluent API for constructing a GetServiceInstanceResponse.

Returns:

the builder

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

canEqual

public final boolean canEqual(Object other)

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object