Class SecretVolumeSource

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.ListModel<KeyToPath>, com.marcnuri.yakc.model.Model

    public class SecretVolumeSource
    extends java.lang.Object
    implements com.marcnuri.yakc.model.Model, com.marcnuri.yakc.model.ListModel<KeyToPath>
    Adapts a Secret into a volume.


    The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

    • Constructor Summary

      Constructors 
      Constructor Description
      SecretVolumeSource()  
      SecretVolumeSource​(java.lang.Number defaultMode, java.util.List<KeyToPath> items, java.lang.Boolean optional, java.lang.String secretName)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SecretVolumeSource.Builder builder()  
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      java.lang.Number getDefaultMode()
      defaultMode is Optional: mode bits used to set permissions on created files by default.
      java.util.List<KeyToPath> getItems()
      items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value.
      java.lang.Boolean getOptional()
      optional field specify whether the Secret or its keys must be defined
      java.lang.String getSecretName()
      secretName is the name of the secret in the pod's namespace to use.
      int hashCode()  
      void setDefaultMode​(java.lang.Number defaultMode)
      defaultMode is Optional: mode bits used to set permissions on created files by default.
      void setItems​(java.util.List<KeyToPath> items)
      items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value.
      void setOptional​(java.lang.Boolean optional)
      optional field specify whether the Secret or its keys must be defined
      void setSecretName​(java.lang.String secretName)
      secretName is the name of the secret in the pod's namespace to use.
      SecretVolumeSource.Builder toBuilder()  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

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

      • SecretVolumeSource

        public SecretVolumeSource​(java.lang.Number defaultMode,
                                  java.util.List<KeyToPath> items,
                                  java.lang.Boolean optional,
                                  java.lang.String secretName)
      • SecretVolumeSource

        public SecretVolumeSource()
    • Method Detail

      • getDefaultMode

        public java.lang.Number getDefaultMode()
        defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
      • getItems

        public java.util.List<KeyToPath> getItems()
        items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
        Specified by:
        getItems in interface com.marcnuri.yakc.model.ListModel<KeyToPath>
      • getOptional

        public java.lang.Boolean getOptional()
        optional field specify whether the Secret or its keys must be defined
      • getSecretName

        public java.lang.String getSecretName()
        secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
      • setDefaultMode

        public void setDefaultMode​(java.lang.Number defaultMode)
        defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
      • setItems

        public void setItems​(java.util.List<KeyToPath> items)
        items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
      • setOptional

        public void setOptional​(java.lang.Boolean optional)
        optional field specify whether the Secret or its keys must be defined
      • setSecretName

        public void setSecretName​(java.lang.String secretName)
        secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
      • 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