com.github.ayltai.gradle.plugin

Class StatefulOptions

java.lang.Object

com.github.ayltai.gradle.plugin.Options

com.github.ayltai.gradle.plugin.StatefulOptions

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BaseApplyOptions, InitOptions

public abstract class StatefulOptions
extends Options

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	input
protected boolean	lock
protected int	lockTimeout

Fields inherited from class com.github.ayltai.gradle.plugin.Options

name, noColor

Constructor Summary

Constructors

Constructor and Description
StatefulOptions(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	input(boolean input) Asks for input if necessary if true is specified.
void	lock(boolean lock) Disables locking of state files during state-related operations if true is specified.
void	lockTimeout(int lockTimeout) Overrides the time Terraform will wait to acquire a state lock with the value specified.

Methods inherited from class com.github.ayltai.gradle.plugin.Options

noColor

Methods inherited from class java.lang.Object

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

Field Detail

input

protected boolean input

lock

protected boolean lock

lockTimeout

protected int lockTimeout

Constructor Detail

StatefulOptions

public StatefulOptions(@Nonnull
                       java.lang.String name)

Method Detail

input

public void input(boolean input)

Asks for input if necessary if true is specified.

Default is true

Parameters:

input - true to ask for input if necessary.

lock

public void lock(boolean lock)

Disables locking of state files during state-related operations if true is specified.

Default is false

Parameters:

lock - true to disable locking of state files during state-related operations.

lockTimeout

public void lockTimeout(int lockTimeout)

Overrides the time Terraform will wait to acquire a state lock with the value specified.

Default is 0, which causes immediate failure if the lock is already held by another process.

Parameters:

lockTimeout - The time Terraform will wait to acquire a state lock.