-
- 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.ConfigurableHelmServerOperationOptions,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.HelmServerOperationOptions,org.unbrokendome.gradle.plugins.helm.command.HelmServerOptions
public class HelmUninstall extends AbstractHelmServerOperationCommandTask
Uninstalls a release from the cluster. Corresponds to the
helm uninstallCLI command.
-
-
Field Summary
Fields Modifier and Type Field Description private final Property<String>releaseNameprivate final Property<Boolean>keepHistoryprivate final Property<Boolean>waitprivate final Property<Boolean>dryRunprivate final Property<Boolean>noHooksprivate final Property<Duration>remoteTimeoutprivate 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 HelmUninstall()
-
Method Summary
Modifier and Type Method Description final Property<String>getReleaseName()The name of the release to be uninstalled. final Property<Boolean>getKeepHistory()If true.final Property<Boolean>getWait()If true, will wait until all the resources are deleted before returning.final Property<Boolean>getDryRun()If true, only simulate the operation.final Property<Boolean>getNoHooks()If true, prevent hooks from running during the operation.final Property<Duration>getRemoteTimeout()Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks). 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 UnituninstallRelease()-
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()
The name of the release to be uninstalled.
-
getKeepHistory
@Internal() final Property<Boolean> getKeepHistory()
If
true. remove all associated resources and mark the release as deleted, but retain the release history.Corresponds to the
--keep-historyCLI parameter.
-
getWait
@Internal() final Property<Boolean> getWait()
If
true, will wait until all the resources are deleted before returning. It will wait for as long as remoteTimeout.Corresponds to the
--waitCLI parameter.
-
getDryRun
@Internal() final Property<Boolean> getDryRun()
If
true, only simulate the operation.Corresponds to the
--dry-runCLI parameter.
-
getNoHooks
@Internal() final Property<Boolean> getNoHooks()
If
true, prevent hooks from running during the operation.Corresponds to the
--no-hooksCLI parameter.
-
getRemoteTimeout
@Internal() final Property<Duration> getRemoteTimeout()
Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks). Default is 300.
Corresponds to the
--timeoutcommand line option in the Helm CLI.
-
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()
-
uninstallRelease
final Unit uninstallRelease()
-
-
-
-