org.microbean.helm.maven

Class AbstractMutatingReleaseMojo

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.AbstractMutatingReleaseMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

AbstractForceableMutatingReleaseMojo, InstallReleaseMojo

public abstract class AbstractMutatingReleaseMojo
extends AbstractSingleReleaseMojo

An AbstractSingleReleaseMojo whose implementations change the single Helm release they are configured to work with (as opposed to just reading its information).

Author:

Laird Nelson

Field Summary

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMutatingReleaseMojo() Creates a new AbstractMutatingReleaseMojo.

Method Summary

Modifier and Type	Method and Description
boolean	getDisableHooks() Returns true if chart hooks are disabled.
boolean	getDryRun() Returns whether this operation will be simulated.
long	getTimeout() Returns the timeout value, in seconds, for Kubernetes operations.
boolean	getWait() Returns true if this operation will wait for Pods to be ready before returning.
void	setDisableHooks(boolean disableHooks) Sets whether chart hooks are disabled.
void	setDryRun(boolean dryRun) Sets whether this operation will be simulated.
void	setTimeout(long timeout) Sets the timeout value, in seconds, for Kubernetes operations.
void	setWait(boolean wait) Sets whether this operation will wait for Pods to be ready before returning.

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, 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

AbstractMutatingReleaseMojo

protected AbstractMutatingReleaseMojo()

Creates a new AbstractMutatingReleaseMojo.

Method Detail

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()

getDryRun

public boolean getDryRun()

Returns whether this operation will be simulated.

Returns:

whether this operation will be simulated

See Also:

setDryRun(boolean)

setDryRun

public void setDryRun(boolean dryRun)

Sets whether this operation will be simulated.

Parameters:

dryRun - if true, this operation will be simulated

See Also:

getDryRun()

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 timeout)

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

Parameters:

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

See Also:

getTimeout()

getWait

public boolean getWait()

Returns true if this operation will wait for Pods to be ready before returning.

Returns:

true if this operation will wait for Pods to be ready before returning

See Also:

setWait(boolean)

setWait

public void setWait(boolean wait)

Sets whether this operation will wait for Pods to be ready before returning.

Parameters:

wait - if true, this operation will wait for Pods to be ready before returning

See Also:

getWait()