Package org.springframework.cloud.servicebroker.model.binding

Class VolumeMount

java.lang.Object

org.springframework.cloud.servicebroker.model.binding.VolumeMount

public class VolumeMount
extends Object

Details of a volume mount in a service binding response.

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 enum	VolumeMount.DeviceType	Values specifying the type of device to mount.
static enum	VolumeMount.Mode	Values designating whether the mounted volume can be written to or read from.
static final class	VolumeMount.VolumeMountBuilder	Provides a fluent API for constructing a VolumeMount.

Constructor Summary

Constructors

Constructor	Description
VolumeMount()	Construct a new VolumeMount.
VolumeMount(String driver, String containerDir, VolumeMount.Mode mode, VolumeMount.DeviceType deviceType, VolumeDevice device)	Construct a new VolumeMount.

Method Summary

Modifier and Type	Method	Description
static VolumeMount.VolumeMountBuilder	builder()	Create a builder that provides a fluent API for constructing a VolumeMount.
final boolean	equals(Object o)
String	getContainerDir()	Set the directory to mount inside the application container.
VolumeDevice	getDevice()	Get the details of the volume device to mount.
VolumeMount.DeviceType	getDeviceType()	Get the type of the volume device to mount.
String	getDriver()	Get the name of the volume driver plugin which manages the device.
VolumeMount.Mode	getMode()	Get a value indicating whether the volume can be mounted in read-only or read-write mode.
final int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

VolumeMount

public VolumeMount()

Construct a new VolumeMount.

VolumeMount

public VolumeMount(String driver,
 String containerDir,
 VolumeMount.Mode mode,
 VolumeMount.DeviceType deviceType,
 VolumeDevice device)

Construct a new VolumeMount.

Parameters:

driver - the name of the driver

containerDir - the container directory

mode - the volume read/write mode

deviceType - the volume device type

device - the volume device details

Method Details

getDriver

public String getDriver()

Get the name of the volume driver plugin which manages the device.

Returns:

the name of the driver

getContainerDir

public String getContainerDir()

Set the directory to mount inside the application container.

Returns:

the container directory

getMode

public VolumeMount.Mode getMode()

Get a value indicating whether the volume can be mounted in read-only or read-write mode.

Returns:

the volume read/write mode

getDeviceType

public VolumeMount.DeviceType getDeviceType()

Get the type of the volume device to mount.

Returns:

the volume device type

getDevice

public VolumeDevice getDevice()

Get the details of the volume device to mount.

Returns:

the volume device details

builder

public static VolumeMount.VolumeMountBuilder builder()

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

Returns:

the builder

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object