Package io.fabric8.kubernetes.api.model

Class FileKeySelector

java.lang.Object

io.fabric8.kubernetes.api.model.FileKeySelector

All Implemented Interfaces:

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

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

FileKeySelector selects a key of the env file.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FileKeySelector()	No args constructor for use in serialization
FileKeySelector(String key, Boolean optional, String path, String volumeName)

Method Summary

Modifier and Type	Method	Description
FileKeySelectorBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getKey()	The key within the env file.
Boolean	getOptional()	Specify whether the file or its key must be defined.
String	getPath()	The path within the volume from which to select the file.
String	getVolumeName()	The name of the volume mount containing the env file.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setKey(String key)	The key within the env file.
void	setOptional(Boolean optional)	Specify whether the file or its key must be defined.
void	setPath(String path)	The path within the volume from which to select the file.
void	setVolumeName(String volumeName)	The name of the volume mount containing the env file.
FileKeySelectorBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileKeySelector

public FileKeySelector()

No args constructor for use in serialization

FileKeySelector

public FileKeySelector(String key,
                       Boolean optional,
                       String path,
                       String volumeName)

Method Detail

getKey

public String getKey()

The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

setKey

public void setKey(String key)

The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

getOptional

public Boolean getOptional()

Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod's containers.

If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.

setOptional

public void setOptional(Boolean optional)

Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod's containers.

If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.

getPath

public String getPath()

The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.

setPath

public void setPath(String path)

The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.

getVolumeName

public String getVolumeName()

The name of the volume mount containing the env file.

setVolumeName

public void setVolumeName(String volumeName)

The name of the volume mount containing the env file.

edit

public FileKeySelectorBuilder edit()

Specified by:

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

toBuilder

public FileKeySelectorBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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