Field Detail

• protected static final java.lang.String JSON_FORMAT

  Command-line parameter for JSON output.

• protected static final java.lang.String NO_COLOR

  Command-line parameter for no colour.

Property Detail

• java.lang.String logLevel

• java.lang.String logLevel

• java.lang.Object sourceSet

Constructor Detail

• protected AbstractTerraformTask(java.lang.String cmd, java.util.List<java.lang.Class> configExtensions, java.util.List<TerraformExtensionConfigTypes> terraformConfigExtensions, java.lang.String workspaceName)

  Parameters:

  command - Command to be executed. See https://www.terraform.io/docs/commands/index.html for details.

  configExtensions - Configuration extensions to be added to this task.

  terraformConfigExtensions - Configuration extensions that are added to the terraform task extension.

  workspaceName - Name of workspace this task is associated with. Set to null for tasks that are workspace-agnostic

Method Detail

• @java.lang.Deprecated protected void addBooleanCmdLineOption(TerraformExecSpec execSpec, java.lang.String optionName, boolean value)

  Adds a boolean command-line option with correct formatting to the execution specification.

  deprecated:

  Parameters:

  execSpec - ExecSpec to configure

  optionName - Name of option

  value - Boolean value

• @java.lang.SuppressWarnings('UnnecessaryGetter') protected void addSessionCredentialsIfAvailable(TerraformExecSpec spec)

• @java.lang.Deprecated protected void addVariableFilesToCmdLine(TerraformExecSpec execSpec, FileCollection collection)

  Add files containing variables to command-line.

  deprecated:

  Parameters:

  execSpec - Specification to be configured

  collection - Collection of files containing variables.

• @java.lang.Deprecated protected void addVariablesToCmdLine(TerraformExecSpec execSpec, java.util.Map<java.lang.String, java.lang.String> vars)

  Adds Terraform variables to execution specification.

  deprecated:

  Parameters:

  execSpec - Specification to be configured.

  vars - Map of variables to be added.

• protected void alwaysOutOfDate()

  Marks task to always be out of date. Calls this from the constructor of Terraform task types that should always be out of date.

  Since:

  0.10.

• @java.lang.Override protected TerraformExecSpec buildExecSpec()

• protected void doNotSwitchWorkspace()

  This task is workspace aware, but workspaces should not be switched

  Since:

  0.10

• protected void doesNotRequireSessionCredentials()

  This specific task does not interact with state and thus does not require any session credentials.

  Since:

  0.11

• @java.lang.Override void exec()

• @Internal Provider<java.io.File> getDataDir()

• @Internal Provider<java.io.File> getLogDir()

• @Internal java.lang.String getLogLevel()

  The level at which Terraform should log to a file.

  Returns:

  Terraform log level. Can be null signifying that logging is switched off.

• @Internal Provider<java.io.File> getReportsDir()

• @InputFiles protected Provider<java.util.List<java.io.File>> getSecondarySources()

  Additional sources that are not in the source set directory, but for which changes will require a re-run of the task. This includes files such as local modules or files that provide variables directly or indirectly.

  Returns:

  List of input files.

  Since:

  0.10

• @Internal Provider<java.io.File> getSourceDir()

• @InputFiles @SkipWhenEmpty protected FileCollection getSourceFiles()

  Files in the source directory that act as input files to determine up to date status.

  Returns:

  File collection

  Since:

  0.10.0

• @Internal TerraformSourceDirectorySet getSourceSet()

• @Input @java.lang.Override protected java.util.Map<java.lang.String, java.lang.String> getTerraformEnvironment()

• @Internal protected TerraformMajorVersion getTerraformMajorVersion()

  Tries to determine the current terraform version group

  Returns:

  Terraform version

  Since:

  0.10.0

• @java.lang.Override protected Provider<java.io.File> getWorkingDirForCommand()

• @Internal java.lang.String getWorkspaceName()

  The workspace name.

  Returns:

  Current workspace name. null for workspace-agnostic tasks.

  Since:

  0.10

• @java.lang.SuppressWarnings('UnnecessaryGetter') protected boolean hasWorkspaces()

  Indicated whether this task is associated with a source set which has workspaces other than just default.

  Returns:

  true if there are workspaces. If the task is workspace-agnostic it will return false even if the associated sourceset has workspaces.

  Since:

  0.10

• @java.lang.SuppressWarnings('UnnecessarySubstring') protected java.util.Map<java.lang.String, java.lang.Boolean> listWorkspaces()

  Lists the workspaces as currently known to Terraform

  Returns:

  List of workspaces.

• protected java.lang.String runWorkspaceSubcommand(java.lang.String cmd, java.lang.String... args)

  Runs a terraform workspace subcommand.

  Parameters:

  cmd - Subcommand to run.

  Returns:

  Output from command.

  Since:

  0.10

• @java.lang.Deprecated @java.lang.SuppressWarnings('DuplicateStringLiteral') void setLogLevel(java.lang.String lvl)

• @java.lang.Deprecated @java.lang.SuppressWarnings('DuplicateStringLiteral') void setLogLevel(org.gradle.api.logging.LogLevel lvl)

• void setLogProgress(boolean state)

  Whether to log progress to the directory specified in getLogDir.

  Parameters:

  state - true to log progress

  Since:

  0.10.0

• void setSourceSet(java.lang.Object source)

  Parameters:

  source - Source set of anything that can be resolved using StringUtils#stringize(Object s)#stringize(Object s) and looked up as a Terraform source set.

• protected void supportsAutoApprove()

  To be called from tasks where the command supports auto-approve.

• protected void supportsColor(boolean withColor = true)

  To be called from tasks where the command supports no-color.

  Will get set if --console=plain was provided to Gradle

  Parameters:

  withColor - If set to false, the task will always run without color output.

• protected void supportsForce()

• protected void supportsInputs()

  To be called from tasks where the command supports input.

• protected void supportsYes()

  To be called from tasks where the command supports yes.

  Since:

  0.10.0

• protected void switchWorkspace()

  Switches workspaces to the correct one if the source set has workspaces and the current workspace is not the correct one. If no additional workspace or the task is workspace agnostic, then it will do-nothing.

  Since:

  0.10

• @groovy.transform.CompileDynamic protected Provider<AbstractTerraformTask> taskProvider(java.lang.String command)

  Provider to another Terraform task.

  Parameters:

  command - Terraform command.

  Returns:

  Task provider.

  Since:

  0.10

• java.lang.String terraformPath(java.lang.Object file)

  Converts a file path to a format suitable for interpretation by Terraform on the appropriate platform.

  Parameters:

  file - Object that can be converted using project.file.

  Returns:

  String version adapted on a per-platform basis

• @java.lang.Deprecated void unsetLogLevel()

• void useAwsEnvironment()

  Adds AWS environmental variables to Terraform runtime environment.

  Since:

  0.6.0