TerraformPlan (Jobble Gradle Plugin Suite Combined API 1.2.1)

org.ysb33r.gradle.terraform.tasks.TerraformPlan

Equivalent of terraform plan.
Since:
0.1

Field Summary

Fields
Modifiers	Name	Description
`protected boolean`	`jsonReport`

Inherited fields
Fields inherited from class	Fields
`class AbstractTerraformTask`	`JSON_FORMAT, NO_COLOR`

Constructor Summary

Constructors
Constructor and description
`TerraformPlan (java.lang.String workspaceName)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected TerraformExecSpec`	`addCommandSpecificsToExecSpec(TerraformExecSpec execSpec)` Add specific command-line options for the command.
	`void`	`exec()`
	`Provider<java.io.File>`	`getInternalTrackerFile()` This is the location of an internal tracker file used to keep state between apply & destroy cycles.
	`Provider<java.io.File>`	`getPlanOutputFile()` Where the plan file will be written to.
	`Provider<java.io.File>`	`getPlanReportOutputFile()` Where the textual representation of the plan will be written to.
	`Provider<java.io.File>`	`getVariablesFile()` This is the location of an variables file used to keep anything provided via the build script.
	`void`	`setJson(boolean state)` Where to write the report in human-readable or JSON format.
	`void`	`setReplacements(java.util.List<java.lang.String> resourceNames)` Mark resources to be replaces.
	`void`	`setTargets(java.util.List<java.lang.String> resourceNames)` Select specific resources.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractTerraformTask`	addBooleanCmdLineOption, addSessionCredentialsIfAvailable, addVariableFilesToCmdLine, addVariablesToCmdLine, alwaysOutOfDate, buildExecSpec, doNotSwitchWorkspace, doesNotRequireSessionCredentials, exec, getDataDir, getLogDir, getLogLevel, getReportsDir, getSecondarySources, getSourceDir, getSourceFiles, getSourceSet, getTerraformEnvironment, getTerraformMajorVersion, getWorkingDirForCommand, getWorkspaceName, hasWorkspaces, listWorkspaces, runWorkspaceSubcommand, setLogProgress, setSourceSet, supportsAutoApprove, supportsColor, supportsForce, supportsInputs, supportsYes, switchWorkspace, taskProvider, terraformPath, useAwsEnvironment
`class AbstractTerraformBaseTask`	`addCommandLineProvider, addCommandSpecificsToExecSpec, buildExecSpec, captureStdOutTo, configureExecSpec, configureExecSpecForCmd, createExecSpec, exec, getCommandLineProviders, getDefaultCommandParameters, getDefaultEnvironment, getEnvironment, getProjectOperations, getProjectTerraform, getStdoutCapture, getTerraformCommand, getTerraformEnvironment, getTerraformExtension, getTerraformrc, getTfVarProviders, getToolExtension, getWorkingDirForCommand, setEnvironment`

- Field Detail
  - protected boolean jsonReport
- Constructor Detail
  - @Inject TerraformPlan(java.lang.String workspaceName)
- Method Detail
  - @java.lang.Override protected TerraformExecSpec addCommandSpecificsToExecSpec(TerraformExecSpec execSpec)
    
    Add specific command-line options for the command. If --refresh-dependencies was specified on the command-line the -upgrade will be passed to terraform init.
    Parameters:
    execSpec
    Returns:
    execSpec
  - @java.lang.Override void exec()
  - @Internal Provider<java.io.File> getInternalTrackerFile()
    
    This is the location of an internal tracker file used to keep state between apply & destroy cycles.
    Returns:
    Location of tracker file.
  - @OutputFile Provider<java.io.File> getPlanOutputFile()
    
    Where the plan file will be written to.
    Returns:
    Location of plan file.
  - @OutputFile Provider<java.io.File> getPlanReportOutputFile()
    
    Where the textual representation of the plan will be written to.
    Returns:
    Location of text file.
  - @Internal Provider<java.io.File> getVariablesFile()
    
    This is the location of an variables file used to keep anything provided via the build script.
    Returns:
    Location of variables file.
    Since:
    0.13.0
  - @Option(option = 'json', description = 'Output readable plan in JSON') void setJson(boolean state)
    
    Where to write the report in human-readable or JSON format.
    Parameters:
    state - Set to true to output in JSON.
  - @Option(option = 'replace', description = 'List of resources to replace') void setReplacements(java.util.List<java.lang.String> resourceNames)
    
    Mark resources to be replaces.
    Parameters:
    resourceNames - List of resources to target.
  - @Option(option = 'target', description = 'List of resources to target') void setTargets(java.util.List<java.lang.String> resourceNames)
    
    Select specific resources.
    Parameters:
    resourceNames - List of resources to target.

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class TerraformPlan

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected boolean jsonReport

Constructor Detail

@Inject TerraformPlan(java.lang.String workspaceName)

Method Detail

@java.lang.Override protected TerraformExecSpec addCommandSpecificsToExecSpec(TerraformExecSpec execSpec)

@java.lang.Override void exec()

@Internal Provider<java.io.File> getInternalTrackerFile()

@OutputFile Provider<java.io.File> getPlanOutputFile()

@OutputFile Provider<java.io.File> getPlanReportOutputFile()

@Internal Provider<java.io.File> getVariablesFile()

@Option(option = 'json', description = 'Output readable plan in JSON') void setJson(boolean state)

@Option(option = 'replace', description = 'List of resources to replace') void setReplacements(java.util.List<java.lang.String> resourceNames)

@Option(option = 'target', description = 'List of resources to target') void setTargets(java.util.List<java.lang.String> resourceNames)