Package io.fabric8.kubernetes.api.model

Class SecretVolumeSource

java.lang.Object

io.fabric8.kubernetes.api.model.SecretVolumeSource

All Implemented Interfaces:

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

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

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SecretVolumeSource()	No args constructor for use in serialization
SecretVolumeSource(Integer defaultMode, List<KeyToPath> items, Boolean optional, String secretName)

Method Summary

Modifier and Type	Method	Description
SecretVolumeSourceBuilder	edit()
Map<String,Object>	getAdditionalProperties()
Integer	getDefaultMode()	defaultMode is Optional: mode bits used to set permissions on created files by default.
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.
Boolean	getOptional()	optional field specify whether the Secret or its keys must be defined
String	getSecretName()	secretName is the name of the secret in the pod's namespace to use.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setDefaultMode(Integer defaultMode)	defaultMode is Optional: mode bits used to set permissions on created files by default.
void	setItems(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(Boolean optional)	optional field specify whether the Secret or its keys must be defined
void	setSecretName(String secretName)	secretName is the name of the secret in the pod's namespace to use.
SecretVolumeSourceBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretVolumeSource

public SecretVolumeSource()

No args constructor for use in serialization

SecretVolumeSource

public SecretVolumeSource(Integer defaultMode,
                          List<KeyToPath> items,
                          Boolean optional,
                          String secretName)

Method Detail

getDefaultMode

public Integer 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.

setDefaultMode

public void setDefaultMode(Integer 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.

getItems

public 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 '..'.

setItems

public void setItems(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 '..'.

getOptional

public Boolean getOptional()

optional field specify whether the Secret or its keys must be defined

setOptional

public void setOptional(Boolean optional)

optional field specify whether the Secret or its keys must be defined

getSecretName

public 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

setSecretName

public void setSecretName(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

edit

public SecretVolumeSourceBuilder edit()

Specified by:

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

toBuilder

public SecretVolumeSourceBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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