org.springframework.cloud.servicebroker.model.binding

Class CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder

java.lang.Object

org.springframework.cloud.servicebroker.model.binding.CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder

Enclosing class:

CreateServiceInstanceAppBindingResponse

public static final class CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder
extends Object

Provides a fluent API for constructing a CreateServiceInstanceAppBindingResponse.

Method Summary

Modifier and Type	Method and Description
CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder	async(boolean async) Set a boolean value indicating whether the requested operation is being performed synchronously or asynchronously.
CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder	bindingExisted(boolean bindingExisted) Set a boolean value indicating whether the service binding already exists with the same parameters as the requested service binding.
CreateServiceInstanceAppBindingResponse	build() Construct a CreateServiceInstanceAppBindingResponse from the provided values.
CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder	credentials(Map<String,Object> credentials) Add a set of credentials from the provided Map to the credentials that the bound application can use to access the service instance.
CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder	credentials(String key, Object value) Add a key/value pair to the that the bound application can use to access the service instance.
CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder	endpoints(Endpoint... endpoints) Add a set of endpoints from the provided array to the endpoints that can be used by an application to connect to the service instance.
CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder	endpoints(List<Endpoint> endpoints) Add a set of endpoints from the provided List to the endpoints that can be used by an application to connect to the service instance.
CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder	operation(String operation) Set a value to inform the user of the operation being performed in support of an asynchronous response.
CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder	syslogDrainUrl(String syslogDrainUrl) Set the URL to which the platform should drain logs for the bound application.
CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder	volumeMounts(List<VolumeMount> volumeMounts) Add a set of volume mounts from the provided List to the volume mounts that can be used in an application container file system.
CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder	volumeMounts(VolumeMount... volumeMounts) Add a set of volume mounts from the provided array to the volume mounts that can be used in an application container file system.

Methods inherited from class java.lang.Object

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

Method Detail

credentials

public CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder credentials(Map<String,Object> credentials)

Add a set of credentials from the provided Map to the credentials that the bound application can use to access the service instance.

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

Parameters:

credentials - a Map of credentials

Returns:

the builder

credentials

public CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder credentials(String key,
                                                                                                          Object value)

Add a key/value pair to the that the bound application can use to access the service instance.

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

Parameters:

key - the credential key

value - the credential value

Returns:

the builder

syslogDrainUrl

public CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder syslogDrainUrl(String syslogDrainUrl)

Set the URL to which the platform should drain logs for the bound application. Can be null to indicate that the service binding does not support syslog drains.

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

Parameters:

syslogDrainUrl - the syslog URL

Returns:

the builder

volumeMounts

public CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder volumeMounts(List<VolumeMount> volumeMounts)

Add a set of volume mounts from the provided List to the volume mounts that can be used in an application container file system.

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

Parameters:

volumeMounts - a List of volume mounts

Returns:

the builder

volumeMounts

public CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder volumeMounts(VolumeMount... volumeMounts)

Add a set of volume mounts from the provided array to the volume mounts that can be used in an application container file system.

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

Parameters:

volumeMounts - one more volume mounts

Returns:

the builder

endpoints

public CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder endpoints(List<Endpoint> endpoints)

Add a set of endpoints from the provided List to the endpoints that can be used by an application to connect to the service instance.

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

Parameters:

endpoints - one more endpoints

Returns:

the builder

endpoints

public CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder endpoints(Endpoint... endpoints)

Add a set of endpoints from the provided array to the endpoints that can be used by an application to connect to the service instance.

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

Parameters:

endpoints - one more endpoints

Returns:

the builder

bindingExisted

public CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder bindingExisted(boolean bindingExisted)

Set a boolean value indicating whether the service binding already exists with the same parameters as the requested service binding. A true value indicates a service binding exists and no new resources were created by the service broker, false indicates that new resources were created.

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

Parameters:

bindingExisted - true to indicate that the binding exists, false otherwise

Returns:

the builder

async

public CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder 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; otherwise the response code will be determined by the value of bindingExisted(boolean).

Parameters:

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

Returns:

the builder

See Also:

bindingExisted(boolean)

operation

public CreateServiceInstanceAppBindingResponse.CreateServiceInstanceAppBindingResponseBuilder 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 GetLastServiceBindingOperationRequest requests.

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

Parameters:

operation - description of the operation being performed

Returns:

the builder

build

public CreateServiceInstanceAppBindingResponse build()

Construct a CreateServiceInstanceAppBindingResponse from the provided values.

Returns:

the newly constructed CreateServiceInstanceAppBindingResponse