com.github.ayltai.gradle.plugin

Class PlanOptions

java.lang.Object

com.github.ayltai.gradle.plugin.Options

com.github.ayltai.gradle.plugin.StatefulOptions

com.github.ayltai.gradle.plugin.BaseApplyOptions

com.github.ayltai.gradle.plugin.PlanOptions

All Implemented Interfaces:

java.io.Serializable

public class PlanOptions
extends BaseApplyOptions

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	destroy
protected boolean	detailedExitCode
protected java.lang.String	out
protected boolean	refresh

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

backup, compactWarnings, parallelism, state, targets

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

input, lock, lockTimeout

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

name, noColor

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	destroy(boolean destroy) Generates a plan to destroy all the known resources if true is specified.
void	detailedExitCode(boolean detailedExitCode) Returns a detailed exit code when the command exits if true is specified.
void	out(java.lang.String out) Sets the path to save the generated execution plan.
void	refresh(boolean refresh) Updates the state prior to checking for differences if true is specified.

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

backup, compactWarnings, parallelism, state, targets

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

input, lock, lockTimeout

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

destroy

protected boolean destroy

detailedExitCode

protected boolean detailedExitCode

out

protected java.lang.String out

refresh

protected boolean refresh

Constructor Detail

PlanOptions

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

Method Detail

destroy

public void destroy(boolean destroy)

Generates a plan to destroy all the known resources if true is specified.

Default is false.

Parameters:

destroy - true to generates plan to destroy all the known resources.

detailedExitCode

public void detailedExitCode(boolean detailedExitCode)

Returns a detailed exit code when the command exits if true is specified.

When true is specified, this changes the exit codes and their meanings to provide more granular information about what the resulting plan contains:

0 = Succeeded with empty diff (no changes)
1 = Error
2 = Succeeded with non-empty diff (changes present)

Default is false.

Parameters:

detailedExitCode - true to return a detailed exit code when the command exits.

out

public void out(@Nonnull
                java.lang.String out)

Sets the path to save the generated execution plan.

This plan can then be used with terraform apply to be certain that only the changes shown in this plan are applied.

Parameters:

out - The path to save the generated execution plan.

refresh

public void refresh(boolean refresh)

Updates the state prior to checking for differences if true is specified.

Default is true.

Parameters:

refresh - true to update the state prior to checking for differences.