-
- All Implemented Interfaces:
-
kotlin.Comparable,org.gradle.api.Task,org.gradle.api.internal.DynamicObjectAware,org.gradle.api.internal.TaskInternal,org.gradle.api.plugins.ExtensionAware,org.gradle.util.Configurable,org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmOptions,org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmServerOptions,org.unbrokendome.gradle.plugins.helm.command.GlobalHelmOptions,org.unbrokendome.gradle.plugins.helm.command.HelmOptions,org.unbrokendome.gradle.plugins.helm.command.HelmServerOptions
public class HelmStatus extends AbstractHelmServerCommandTask
Check the status for a release. Corresponds to the
helm statusCLI command.
-
-
Field Summary
Fields Modifier and Type Field Description private final Property<String>releaseNameprivate final Property<Integer>revisionprivate final RegularFilePropertyoutputFileprivate final Property<String>outputFormatprivate final RegularFilePropertykubeConfigprivate final Property<String>kubeContextprivate final Property<String>namespaceprivate final Provider<String>executableprivate final Provider<Boolean>debugprivate final Provider<List<String>>extraArgsprivate final Provider<Directory>xdgDataHomeprivate final Provider<Directory>xdgConfigHomeprivate final Provider<Directory>xdgCacheHome
-
Constructor Summary
Constructors Constructor Description HelmStatus()
-
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 RegularFilePropertygetOutputFile()Output file for storing the status report from helm status.final Property<String>getOutputFormat()Desired output format. final RegularFilePropertygetKubeConfig()Path to the Kubernetes configuration file. final Property<String>getKubeContext()Name of the kubeconfig context to use. final Property<String>getNamespace()Namespace scope for this request. final Provider<String>getExecutable()final Provider<Boolean>getDebug()final Provider<List<String>>getExtraArgs()final Provider<Directory>getXdgDataHome()final Provider<Directory>getXdgConfigHome()final Provider<Directory>getXdgCacheHome()final Unitstatus()-
Methods inherited from class org.unbrokendome.gradle.plugins.helm.command.tasks.AbstractHelmCommandTask
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService -
Methods inherited from class org.gradle.api.DefaultTask
appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, isEnabled, isHasCustomActions, prependParallelSafeAction, setImpliesSubProjects, setLoggerMessageRewriter -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
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
--revisionCLI 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 formatjsonwill be used.Corresponds to the
--outputCLI option.
-
getKubeConfig
@InputFile()@Optional() final RegularFileProperty getKubeConfig()
Path to the Kubernetes configuration file.
If this property is set, its value will be used to set the
KUBECONFIGenvironment variable for each Helm invocation.
-
getKubeContext
@Input()@Optional() final Property<String> getKubeContext()
Name of the kubeconfig context to use.
Corresponds to the
--kube-contextcommand line option in the Helm CLI.
-
getNamespace
@Internal() final Property<String> getNamespace()
Namespace scope for this request.
Corresponds to the
--namespaceCLI parameter.
-
getExecutable
@Input() final Provider<String> getExecutable()
-
getExtraArgs
@Input() final Provider<List<String>> getExtraArgs()
-
getXdgDataHome
@Internal() final Provider<Directory> getXdgDataHome()
-
getXdgConfigHome
@Internal() final Provider<Directory> getXdgConfigHome()
-
getXdgCacheHome
@Internal() final Provider<Directory> getXdgCacheHome()
-
-
-
-