com.github.dockerjava.api.model

Class Bind

java.lang.Object

com.github.dockerjava.api.model.DockerObject

com.github.dockerjava.api.model.Bind

All Implemented Interfaces:

Serializable

public class Bind
extends DockerObject
implements Serializable

Represents a host path being bind mounted as a Volume in a Docker container. The Bind can be in read only or read write access mode.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Bind(String path, Volume volume)
Bind(String path, Volume volume, AccessMode accessMode)
Bind(String path, Volume volume, AccessMode accessMode, SELContext secMode)
Bind(String path, Volume volume, AccessMode accessMode, SELContext secMode, Boolean noCopy)
Bind(String path, Volume volume, AccessMode accessMode, SELContext secMode, Boolean noCopy, PropagationMode propagationMode)
Bind(String path, Volume volume, Boolean noCopy)

Method Summary

Modifier and Type	Method and Description
AccessMode	getAccessMode()
Boolean	getNoCopy()
String	getPath()
PropagationMode	getPropagationMode()
SELContext	getSecMode()
Volume	getVolume()
static Bind	parse(String serialized) Parses a bind mount specification to a Bind.
String	toString() Returns a string representation of this Bind suitable for inclusion in a JSON message.

Methods inherited from class com.github.dockerjava.api.model.DockerObject

getRawValues

Methods inherited from class java.lang.Object

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

Constructor Detail

Bind

public Bind(String path,
            Volume volume)

Bind

public Bind(String path,
            Volume volume,
            Boolean noCopy)

Bind

public Bind(String path,
            Volume volume,
            AccessMode accessMode)

Bind

public Bind(String path,
            Volume volume,
            AccessMode accessMode,
            SELContext secMode)

Bind

public Bind(String path,
            Volume volume,
            AccessMode accessMode,
            SELContext secMode,
            Boolean noCopy)

Bind

public Bind(String path,
            Volume volume,
            AccessMode accessMode,
            SELContext secMode,
            Boolean noCopy,
            PropagationMode propagationMode)

Method Detail

getPath

public String getPath()

getVolume

public Volume getVolume()

getAccessMode

public AccessMode getAccessMode()

getSecMode

public SELContext getSecMode()

getNoCopy

public Boolean getNoCopy()

getPropagationMode

public PropagationMode getPropagationMode()

parse

public static Bind parse(String serialized)

Parses a bind mount specification to a Bind.

Parameters:

serialized - the specification, e.g. /host:/container:ro

Returns:

a Bind matching the specification

Throws:

IllegalArgumentException - if the specification cannot be parsed

toString

public String toString()

Returns a string representation of this Bind suitable for inclusion in a JSON message. The format is <host path>:<container path>:<access mode>, like the argument in parse(String).

Overrides:

toString in class Object

Returns:

a string representation of this Bind