public class PlanOptions extends BaseApplyOptions
| Modifier and Type | Field and Description |
|---|---|
protected boolean |
destroy |
protected boolean |
detailedExitCode |
protected java.lang.String |
out |
protected boolean |
refresh |
backup, compactWarnings, parallelism, state, targetsinput, lock, lockTimeout| Constructor and Description |
|---|
PlanOptions(java.lang.String name) |
| 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. |
backup, compactWarnings, parallelism, state, targetsinput, lock, lockTimeoutprotected boolean destroy
protected boolean detailedExitCode
protected java.lang.String out
protected boolean refresh
public void destroy(boolean destroy)
true is specified.
Default is false.
destroy - true to generates plan to destroy all the known resources.public void detailedExitCode(boolean detailedExitCode)
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 = Error2 = Succeeded with non-empty diff (changes present)
Default is false.
detailedExitCode - true to return a detailed exit code when the command exits.public void out(@Nonnull
java.lang.String out)
This plan can then be used with terraform apply to be certain that only the changes shown in this plan are applied.
out - The path to save the generated execution plan.public void refresh(boolean refresh)
true is specified.
Default is true.
refresh - true to update the state prior to checking for differences.