Package io.fabric8.kubernetes.api.model

Class ConfigMapVolumeSource

java.lang.Object

io.fabric8.kubernetes.api.model.ConfigMapVolumeSource

All Implemented Interfaces:

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

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

Adapts a ConfigMap into a volume.

The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ConfigMapVolumeSourceBuilder	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 ConfigMap will be projected into the volume as a file whose name is the key and content is the value.
String	getName()	Name of the referent.
Boolean	getOptional()	optional specify whether the ConfigMap or its keys must be defined
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 ConfigMap will be projected into the volume as a file whose name is the key and content is the value.
void	setName(String name)	Name of the referent.
void	setOptional(Boolean optional)	optional specify whether the ConfigMap or its keys must be defined
ConfigMapVolumeSourceBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigMapVolumeSource

public ConfigMapVolumeSource()

No args constructor for use in serialization

ConfigMapVolumeSource

public ConfigMapVolumeSource(Integer defaultMode,
                             List<KeyToPath> items,
                             String name,
                             Boolean optional)

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 ConfigMap 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 ConfigMap, 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 ConfigMap 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 ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

getName

public String getName()

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

setName

public void setName(String name)

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

getOptional

public Boolean getOptional()

optional specify whether the ConfigMap or its keys must be defined

setOptional

public void setOptional(Boolean optional)

optional specify whether the ConfigMap or its keys must be defined

edit

public ConfigMapVolumeSourceBuilder edit()

Specified by:

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

toBuilder

public ConfigMapVolumeSourceBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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