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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  8. 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.

  9. 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.

  10. def getValueFrom: IO[K8sFailure, EnvVarSource]

    Gets valueFrom.

    Gets valueFrom.

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

  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val name: String
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. val value: Optional[String]
  18. val valueFrom: Optional[EnvVarSource]
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped