Class VolumeMount
- java.lang.Object
-
- io.fabric8.kubernetes.api.model.VolumeMount
-
- All Implemented Interfaces:
Editable<VolumeMountBuilder>,KubernetesResource,Serializable
@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator") public class VolumeMount extends Object implements Editable<VolumeMountBuilder>, KubernetesResource
VolumeMount describes a mounting of a Volume within a container.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VolumeMountBuilderedit()Map<String,Object>getAdditionalProperties()List<String>getBindMountOptions()bindMountOptions is the list of additional bind mount options to apply when mounting this volume into the container.StringgetMountPath()Path within the container at which the volume should be mounted.StringgetMountPropagation()mountPropagation determines how mounts are propagated from the host to container and the other way around.StringgetName()This must match the Name of a Volume.BooleangetReadOnly()Mounted read-only if true, read-write otherwise (false or unspecified).StringgetRecursiveReadOnly()RecursiveReadOnly specifies whether read-only mounts should be handled recursively.StringgetSubPath()Path within the volume from which the container's volume should be mounted.StringgetSubPathExpr()Expanded path within the volume from which the container's volume should be mounted.voidsetAdditionalProperties(Map<String,Object> additionalProperties)voidsetAdditionalProperty(String name, Object value)voidsetBindMountOptions(List<String> bindMountOptions)bindMountOptions is the list of additional bind mount options to apply when mounting this volume into the container.voidsetMountPath(String mountPath)Path within the container at which the volume should be mounted.voidsetMountPropagation(String mountPropagation)mountPropagation determines how mounts are propagated from the host to container and the other way around.voidsetName(String name)This must match the Name of a Volume.voidsetReadOnly(Boolean readOnly)Mounted read-only if true, read-write otherwise (false or unspecified).voidsetRecursiveReadOnly(String recursiveReadOnly)RecursiveReadOnly specifies whether read-only mounts should be handled recursively.voidsetSubPath(String subPath)Path within the volume from which the container's volume should be mounted.voidsetSubPathExpr(String subPathExpr)Expanded path within the volume from which the container's volume should be mounted.VolumeMountBuildertoBuilder()
-
-
-
Method Detail
-
getBindMountOptions
public List<String> getBindMountOptions()
bindMountOptions is the list of additional bind mount options to apply when mounting this volume into the container. Allowed values are noexec, nodev, and nosuid. These are Linux mount options and have no effect on Windows nodes. This field is not supported with image volumes. This is an alpha field and requires enabling the VolumeBindMountOptions feature gate.
-
setBindMountOptions
public void setBindMountOptions(List<String> bindMountOptions)
bindMountOptions is the list of additional bind mount options to apply when mounting this volume into the container. Allowed values are noexec, nodev, and nosuid. These are Linux mount options and have no effect on Windows nodes. This field is not supported with image volumes. This is an alpha field and requires enabling the VolumeBindMountOptions feature gate.
-
getMountPath
public String getMountPath()
Path within the container at which the volume should be mounted.
-
setMountPath
public void setMountPath(String mountPath)
Path within the container at which the volume should be mounted.
-
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:
editin interfaceEditable<VolumeMountBuilder>
-
toBuilder
public VolumeMountBuilder toBuilder()
-
-