org.springframework.cloud.servicebroker.model.instance

Class UpdateServiceInstanceResponse.UpdateServiceInstanceResponseBuilder

java.lang.Object

org.springframework.cloud.servicebroker.model.instance.UpdateServiceInstanceResponse.UpdateServiceInstanceResponseBuilder

Enclosing class:

UpdateServiceInstanceResponse

public static final class UpdateServiceInstanceResponse.UpdateServiceInstanceResponseBuilder
extends Object

Provides a fluent API for constructing an UpdateServiceInstanceResponse.

Method Summary

Modifier and Type	Method and Description
UpdateServiceInstanceResponse.UpdateServiceInstanceResponseBuilder	async(boolean async) Set a boolean value indicating whether the requested operation is being performed synchronously or asynchronously.
UpdateServiceInstanceResponse	build() Construct an UpdateServiceInstanceResponse from the provided values.
UpdateServiceInstanceResponse.UpdateServiceInstanceResponseBuilder	dashboardUrl(String dashboardUrl) Set the URL of a web-based management user interface provided by the service broker for the service instance.
UpdateServiceInstanceResponse.UpdateServiceInstanceResponseBuilder	operation(String operation) Set a value to inform the user of the operation being performed in support of an asynchronous response.

Methods inherited from class java.lang.Object

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

Method Detail

dashboardUrl

public UpdateServiceInstanceResponse.UpdateServiceInstanceResponseBuilder 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

async

public UpdateServiceInstanceResponse.UpdateServiceInstanceResponseBuilder async(boolean async)

Set a boolean value indicating whether the requested operation is being performed synchronously or asynchronously.

This value will be used to determine the HTTP response code to the platform. A true value will result in a response code 202 ACCEPTED, and a false value will result in a response code 200 OK.

Parameters:

async - true to indicate that the operation is being performed asynchronously, false to indicate that the operation was completed

Returns:

the builder

operation

public UpdateServiceInstanceResponse.UpdateServiceInstanceResponseBuilder operation(String operation)

Set a value to inform the user of the operation being performed in support of an asynchronous response. This value will be passed back to the service broker in subsequent GetLastServiceOperationRequest requests.

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

Parameters:

operation - the informational value

Returns:

the builder

build

public UpdateServiceInstanceResponse build()

Construct an UpdateServiceInstanceResponse from the provided values.

Returns:

the newly constructed UpdateServiceInstanceResponse