Package io.fabric8.kubernetes.api.model

Class VolumeMount

java.lang.Object

io.fabric8.kubernetes.api.model.VolumeMount

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<VolumeMountBuilder>, KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class VolumeMount
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<VolumeMountBuilder>, KubernetesResource

VolumeMount describes a mounting of a Volume within a container.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
VolumeMount()	No args constructor for use in serialization
VolumeMount(String mountPath, String mountPropagation, String name, Boolean readOnly, String recursiveReadOnly, String subPath, String subPathExpr)

Method Summary

Modifier and Type	Method	Description
VolumeMountBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getMountPath()	Path within the container at which the volume should be mounted.
String	getMountPropagation()	mountPropagation determines how mounts are propagated from the host to container and the other way around.
String	getName()	This must match the Name of a Volume.
Boolean	getReadOnly()	Mounted read-only if true, read-write otherwise (false or unspecified).
String	getRecursiveReadOnly()	RecursiveReadOnly specifies whether read-only mounts should be handled recursively.
String	getSubPath()	Path within the volume from which the container's volume should be mounted.
String	getSubPathExpr()	Expanded path within the volume from which the container's volume should be mounted.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setMountPath(String mountPath)	Path within the container at which the volume should be mounted.
void	setMountPropagation(String mountPropagation)	mountPropagation determines how mounts are propagated from the host to container and the other way around.
void	setName(String name)	This must match the Name of a Volume.
void	setReadOnly(Boolean readOnly)	Mounted read-only if true, read-write otherwise (false or unspecified).
void	setRecursiveReadOnly(String recursiveReadOnly)	RecursiveReadOnly specifies whether read-only mounts should be handled recursively.
void	setSubPath(String subPath)	Path within the volume from which the container's volume should be mounted.
void	setSubPathExpr(String subPathExpr)	Expanded path within the volume from which the container's volume should be mounted.
VolumeMountBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

VolumeMount

public VolumeMount()

No args constructor for use in serialization

VolumeMount

public VolumeMount(String mountPath,
                   String mountPropagation,
                   String name,
                   Boolean readOnly,
                   String recursiveReadOnly,
                   String subPath,
                   String subPathExpr)

Method Detail

getMountPath

public String getMountPath()

Path within the container at which the volume should be mounted. Must not contain ':'.

setMountPath

public void setMountPath(String mountPath)

Path within the container at which the volume should be mounted. Must not contain ':'.

getMountPropagation

public String getMountPropagation()

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

setMountPropagation

public void setMountPropagation(String mountPropagation)

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

getName

public String getName()

This must match the Name of a Volume.

setName

public void setName(String name)

This must match the Name of a Volume.

getReadOnly

public Boolean getReadOnly()

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

setReadOnly

public void setReadOnly(Boolean readOnly)

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

getRecursiveReadOnly

public String getRecursiveReadOnly()

RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.

setRecursiveReadOnly

public void setRecursiveReadOnly(String recursiveReadOnly)

RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.

getSubPath

public String getSubPath()

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

setSubPath

public void setSubPath(String subPath)

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

getSubPathExpr

public String getSubPathExpr()

Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

setSubPathExpr

public void setSubPathExpr(String subPathExpr)

Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

edit

public VolumeMountBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<VolumeMountBuilder>

toBuilder

public VolumeMountBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)