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

Class HelmStatus

  • All Implemented Interfaces:
    io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmServerOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.GlobalHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmServerOptions , kotlin.Comparable , org.gradle.api.Named , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable 
    
public class HelmStatus
extends AbstractHelmServerCommandTask

    Check the status for a release. Corresponds to the helm status CLI command.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description
      HelmStatus()

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final Property<String> getReleaseName() Name of the release to test the status for.
      final Property<Integer> getRevision() If set, display the status of the named release with revision.
      final RegularFileProperty getOutputFile() Output file for storing the status report from helm status.
      final Property<String> getOutputFormat() Desired output format.
      final Unit status()

      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.command.tasks.AbstractHelmServerCommandTask

        getKubeConfig, getKubeContext, getNamespace

      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.command.tasks.AbstractHelmCommandTask

        getDebug, getExecutable, getExtraArgs, getXdgCacheHome, getXdgConfigHome, getXdgDataHome

      • Methods inherited from class org.gradle.api.internal.AbstractTask

        acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

      • Methods inherited from class org.gradle.api.DefaultTask

        compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HelmStatus

        HelmStatus()

    • Method Detail

      • getReleaseName

        @Input() final Property<String> getReleaseName()

        Name of the release to test the status for.

      • getRevision

        @Input()@Optional() final Property<Integer> getRevision()

        If set, display the status of the named release with revision.

        Corresponds to the --revision CLI option.

      • getOutputFile

        @OutputFile()@Optional() final RegularFileProperty getOutputFile()

        Output file for storing the status report from helm status.

        If not set, the status will be printed to stdout.

      • getOutputFormat

        @Input()@Optional() final Property<String> getOutputFormat()

        Desired output format. Allowed values: table, json, yaml.

        If not set, and the outputFile is set, the correct output format will be guessed based on the extension of the output file. For example, if outputFile is set to a file name that has the extension .json, the format json will be used.

        Corresponds to the --output CLI option.