org.microbean.helm.maven

Class UninstallReleaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.microbean.helm.maven.AbstractHelmMojo

org.microbean.helm.maven.AbstractReleaseMojo

org.microbean.helm.maven.AbstractSingleReleaseMojo

org.microbean.helm.maven.UninstallReleaseMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="uninstall")
public class UninstallReleaseMojo
extends AbstractSingleReleaseMojo

Uninstalls a release.

Author:

Laird Nelson

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
UninstallReleaseMojo() Creates a new UninstallReleaseMojo.

Method Summary

Modifier and Type	Method and Description
protected void	execute(Callable<ReleaseManager> releaseManagerCallable) Performs a release-oriented task using a ReleaseManager available from the supplied Callable.
boolean	getDisableHooks() Returns true if chart hooks are disabled.
boolean	getPurge() Returns whether the release being uninstalled should be purged entirely instead of being marked as deleted.
long	getTimeout() Returns the timeout value, in seconds, for Kubernetes operations.
void	setDisableHooks(boolean disableHooks) Sets whether chart hooks are disabled.
void	setPurge(boolean purge) Sets whether the release being uninstalled should be purged entirely instead of being marked as deleted.
void	setTimeout(long timeoutInSeconds) Sets the timeout value, in seconds, for Kubernetes operations.

Methods inherited from class org.microbean.helm.maven.AbstractSingleReleaseMojo

getReleaseName, setReleaseName, validateReleaseName

Methods inherited from class org.microbean.helm.maven.AbstractReleaseMojo

createClient, createReleaseManager, createTiller, execute, getClientConfiguration, getSkip, getTillerLabels, getTillerNamespace, getTillerPort, setClientConfiguration, setSkip, setTillerLabels, setTillerNamespace, setTillerPort, validateNamespace

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

UninstallReleaseMojo

public UninstallReleaseMojo()

Creates a new UninstallReleaseMojo.

Method Detail

execute

protected void execute(Callable<ReleaseManager> releaseManagerCallable)
                throws Exception

Performs a release-oriented task using a ReleaseManager available from the supplied Callable.

This implementation uninstalls the release with the supplied release name.

Specified by:

execute in class AbstractReleaseMojo

Parameters:

releaseManagerCallable - the Callable that will provide a ReleaseManager; must not be null

Throws:

Exception - if an error occurs

getDisableHooks

public boolean getDisableHooks()

Returns true if chart hooks are disabled.

Returns:

true if chart hooks are disabled

See Also:

setDisableHooks(boolean)

setDisableHooks

public void setDisableHooks(boolean disableHooks)

Sets whether chart hooks are disabled.

Parameters:

disableHooks - if true, chart hooks will be disabled

See Also:

getDisableHooks()

getPurge

public boolean getPurge()

Returns whether the release being uninstalled should be purged entirely instead of being marked as deleted.

Returns:

true if the release being uninstalled should be purged entirely instead of being marked as deleted; false if it should be marked as deleted

See Also:

setPurge(boolean)

setPurge

public void setPurge(boolean purge)

Sets whether the release being uninstalled should be purged entirely instead of being marked as deleted.

Parameters:

purge - if true the release being uninstalled will be purged entirely

See Also:

getPurge()

getTimeout

public long getTimeout()

Returns the timeout value, in seconds, for Kubernetes operations.

Returns:

the timeout value, in seconds, for Kubernetes operations

See Also:

setTimeout(long)

setTimeout

public void setTimeout(long timeoutInSeconds)

Sets the timeout value, in seconds, for Kubernetes operations.

Parameters:

timeoutInSeconds - the timeout value, in seconds, for Kubernetes operations

See Also:

getTimeout()