Packages

case class EnvVar(name: String, value: Optional[String] = Optional.Absent, valueFrom: Optional[EnvVarSource] = Optional.Absent) extends Product with Serializable

EnvVar represents an environment variable present in a Container.

name

Name of the environment variable. Must be a C_IDENTIFIER.

value

Variable references $$(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$$$ are reduced to a single $$, which allows for escaping the $$(VAR_NAME) syntax: i.e. "$$$$(VAR_NAME)" will produce the string literal "$$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EnvVar
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EnvVar(name: String, value: Optional[String] = Optional.Absent, valueFrom: Optional[EnvVarSource] = Optional.Absent)

    name

    Name of the environment variable. Must be a C_IDENTIFIER.

    value

    Variable references $$(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$$$ are reduced to a single $$, which allows for escaping the $$(VAR_NAME) syntax: i.e. "$$$$(VAR_NAME)" will produce the string literal "$$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

Value Members

  1. def getName: IO[K8sFailure, String]

    Name of the environment variable.

    Name of the environment variable. Must be a C_IDENTIFIER.

    This effect always succeeds, it is safe to use the field name directly.

  2. def getValue: IO[K8sFailure, String]

    Variable references $$(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables.

    Variable references $$(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$$$ are reduced to a single $$, which allows for escaping the $$(VAR_NAME) syntax: i.e. "$$$$(VAR_NAME)" will produce the string literal "$$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  3. def getValueFrom: IO[K8sFailure, EnvVarSource]

    Gets valueFrom.

    Gets valueFrom.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  4. val name: String
  5. val value: Optional[String]
  6. val valueFrom: Optional[EnvVarSource]