Package org.springframework.cloud.servicebroker.model.instance

Class CreateServiceInstanceResponse

java.lang.Object

org.springframework.cloud.servicebroker.model.AsyncServiceBrokerResponse

org.springframework.cloud.servicebroker.model.instance.CreateServiceInstanceResponse

public class CreateServiceInstanceResponse
extends AsyncServiceBrokerResponse

Details of a response to a request to create a new 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	Description
static final class	CreateServiceInstanceResponse.CreateServiceInstanceResponseBuilder	Provides a fluent API for constructing a CreateServiceInstanceResponse.

Field Summary

Fields inherited from class org.springframework.cloud.servicebroker.model.AsyncServiceBrokerResponse

async, operation

Constructor Summary

Constructors

Constructor	Description
CreateServiceInstanceResponse()	Construct a new CreateServiceInstanceResponse
CreateServiceInstanceResponse(boolean async, String operation, String dashboardUrl, boolean instanceExisted, ServiceInstanceMetadata metadata)	Construct a new CreateServiceInstanceResponse

Method Summary

Modifier and Type	Method	Description
static CreateServiceInstanceResponse.CreateServiceInstanceResponseBuilder	builder()	Create a builder that provides a fluent API for constructing a CreateServiceInstanceResponse.
boolean	canEqual(Object other)	Is another object type compatible with this object
final boolean	equals(Object o)
String	getDashboardUrl()	Get the URL of a web-based management user interface for the service instance.
ServiceInstanceMetadata	getMetadata()	Get object containing metadata for the service instance
final int	hashCode()
boolean	isInstanceExisted()	Get the boolean value indicating whether the service instance already exists with the same parameters as the requested service instance.
String	toString()

Methods inherited from class org.springframework.cloud.servicebroker.model.AsyncServiceBrokerResponse

getOperation, isAsync, validateOperationLength

Methods inherited from class java.lang.Object

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

Constructor Details

CreateServiceInstanceResponse

public CreateServiceInstanceResponse()

Construct a new CreateServiceInstanceResponse

CreateServiceInstanceResponse

public CreateServiceInstanceResponse(boolean async,
 String operation,
 String dashboardUrl,
 boolean instanceExisted,
 ServiceInstanceMetadata metadata)

Construct a new CreateServiceInstanceResponse

Parameters:

async - is the operation asynchronous

operation - description of the operation being performed

dashboardUrl - the dashboard URL

instanceExisted - true if the instance exists

metadata - containing metadata for the service instance

Method Details

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

isInstanceExisted

public boolean isInstanceExisted()

Get the boolean value indicating whether the service instance already exists with the same parameters as the requested service instance.

Returns:

the boolean value

getMetadata

public ServiceInstanceMetadata getMetadata()

Get object containing metadata for the service instance

Returns:

the service instance metadata

builder

public static CreateServiceInstanceResponse.CreateServiceInstanceResponseBuilder builder()

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

Returns:

the builder

equals

public final boolean equals(Object o)

Overrides:

equals in class AsyncServiceBrokerResponse

canEqual

public boolean canEqual(Object other)

Description copied from class: AsyncServiceBrokerResponse

Is another object type compatible with this object

Overrides:

canEqual in class AsyncServiceBrokerResponse

Parameters:

other - the other object

Returns:

true of compatible

hashCode

public final int hashCode()

Overrides:

hashCode in class AsyncServiceBrokerResponse

toString

public String toString()

Overrides:

toString in class AsyncServiceBrokerResponse