VolumeMount

case class VolumeMount(mountPath: String, mountPropagation: Optional[String], name: String, readOnly: Optional[Boolean], subPath: Optional[String], subPathExpr: Optional[String])

VolumeMount describes a mounting of a Volume within a container.

VolumeMount describes a mounting of a Volume within a container.

Value Params
mountPath

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

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.

name

This must match the Name of a Volume.

readOnly

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

subPath

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

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.

Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def getMountPath: IO[K8sFailure, String]

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

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

This effect always succeeds, it is safe to use the field mountPath directly.

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.

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.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getName: IO[K8sFailure, String]

This must match the Name of a Volume.

This must match the Name of a Volume.

This effect always succeeds, it is safe to use the field name directly.

def getReadOnly: IO[K8sFailure, Boolean]

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

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

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getSubPath: IO[K8sFailure, String]

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

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

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getSubPathExpr: IO[K8sFailure, String]

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.

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.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product