Package io.github.build.extensions.oss.gradle.plugins.helm.command

Interface ConfigurableGlobalHelmOptions

  • All Implemented Interfaces:
    io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.GlobalHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmOptions 
    
public interface ConfigurableGlobalHelmOptions
 implements GlobalHelmOptions, ConfigurableHelmOptions

    Holds options that apply to all Helm commands.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Property<String> getExecutable() The name or path of the Helm executable.
      abstract Property<Boolean> getDebug() Indicates whether to use the verbose output (--debug flag) when invoking commands.
      abstract ListProperty<String> getExtraArgs() Additional command-line arguments to pass to the Helm CLI.
      abstract DirectoryProperty getXdgDataHome() Base directory for storing data.
      abstract DirectoryProperty getXdgConfigHome() Base directory for storing configuration.
      abstract DirectoryProperty getXdgCacheHome() Base directory for storing cached data.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getExecutable

         abstract Property<String> getExecutable()

        The name or path of the Helm executable. The PATH variable is taken into account, so this can just be "helm" if the Helm client is installed in a suitable location.

      • getDebug

         abstract Property<Boolean> getDebug()

        Indicates whether to use the verbose output (--debug flag) when invoking commands.

      • getExtraArgs

         abstract ListProperty<String> getExtraArgs()

        Additional command-line arguments to pass to the Helm CLI.

        This can be used for command-line options that have no counterpart in the plugin.

      • getXdgDataHome

         abstract DirectoryProperty getXdgDataHome()

        Base directory for storing data.

        Corresponds to the XDG_DATA_HOME environment variable. If not set, defaults to helm/data inside the project build directory.

        See [https://helm.sh/docs/helm/helm/] for details about how XDG base directories are used by the Helm CLI.

      • getXdgConfigHome

         abstract DirectoryProperty getXdgConfigHome()

        Base directory for storing configuration.

        Corresponds to the XDG_CONFIG_HOME environment variable. If not set, defaults to helm/config inside the project build directory.

        See [https://helm.sh/docs/helm/helm/] for details about how XDG base directories are used by the Helm CLI.

      • getXdgCacheHome

         abstract DirectoryProperty getXdgCacheHome()

        Base directory for storing cached data.

        Corresponds to the XDG_CACHE_HOME environment variable. If not set, defaults to .gradle/helm/cache inside the root project directory.

        See [https://helm.sh/docs/helm/helm/] for details about how XDG base directories are used by the Helm CLI.