Class VolumeMount

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.Model

    public class VolumeMount
    extends java.lang.Object
    implements com.marcnuri.yakc.model.Model
    VolumeMount describes a mounting of a Volume within a container.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  VolumeMount.Builder  
    • Constructor Summary

      Constructors 
      Constructor Description
      VolumeMount()  
      VolumeMount​(@NonNull java.lang.String mountPath, java.lang.String mountPropagation, @NonNull java.lang.String name, java.lang.Boolean readOnly, java.lang.String subPath, java.lang.String subPathExpr)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static VolumeMount.Builder builder()  
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      @NonNull java.lang.String getMountPath()
      Path within the container at which the volume should be mounted.
      java.lang.String getMountPropagation()
      mountPropagation determines how mounts are propagated from the host to container and the other way around.
      @NonNull java.lang.String getName()
      This must match the Name of a Volume.
      java.lang.Boolean getReadOnly()
      Mounted read-only if true, read-write otherwise (false or unspecified).
      java.lang.String getSubPath()
      Path within the volume from which the container's volume should be mounted.
      java.lang.String getSubPathExpr()
      Expanded path within the volume from which the container's volume should be mounted.
      int hashCode()  
      void setMountPath​(@NonNull java.lang.String mountPath)
      Path within the container at which the volume should be mounted.
      void setMountPropagation​(java.lang.String mountPropagation)
      mountPropagation determines how mounts are propagated from the host to container and the other way around.
      void setName​(@NonNull java.lang.String name)
      This must match the Name of a Volume.
      void setReadOnly​(java.lang.Boolean readOnly)
      Mounted read-only if true, read-write otherwise (false or unspecified).
      void setSubPath​(java.lang.String subPath)
      Path within the volume from which the container's volume should be mounted.
      void setSubPathExpr​(java.lang.String subPathExpr)
      Expanded path within the volume from which the container's volume should be mounted.
      VolumeMount.Builder toBuilder()  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • VolumeMount

        public VolumeMount​(@NonNull
                           @NonNull java.lang.String mountPath,
                           java.lang.String mountPropagation,
                           @NonNull
                           @NonNull java.lang.String name,
                           java.lang.Boolean readOnly,
                           java.lang.String subPath,
                           java.lang.String subPathExpr)
      • VolumeMount

        public VolumeMount()
    • Method Detail

      • getMountPath

        @NonNull
        public @NonNull java.lang.String getMountPath()
        Path within the container at which the volume should be mounted. Must not contain ':'.
      • getMountPropagation

        public java.lang.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.
      • getName

        @NonNull
        public @NonNull java.lang.String getName()
        This must match the Name of a Volume.
      • getReadOnly

        public java.lang.Boolean getReadOnly()
        Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
      • getSubPath

        public java.lang.String getSubPath()
        Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
      • getSubPathExpr

        public java.lang.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.
      • setMountPath

        public void setMountPath​(@NonNull
                                 @NonNull java.lang.String mountPath)
        Path within the container at which the volume should be mounted. Must not contain ':'.
      • setMountPropagation

        public void setMountPropagation​(java.lang.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.
      • setName

        public void setName​(@NonNull
                            @NonNull java.lang.String name)
        This must match the Name of a Volume.
      • setReadOnly

        public void setReadOnly​(java.lang.Boolean readOnly)
        Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
      • setSubPath

        public void setSubPath​(java.lang.String subPath)
        Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
      • setSubPathExpr

        public void setSubPathExpr​(java.lang.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.
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • canEqual

        protected boolean canEqual​(java.lang.Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object