TerraformConfigUtils (Jobble Gradle Plugin Suite Combined API 0.13.1)

org.ysb33r.gradle.terraform.internal.TerraformConfigUtils

Internal utilities for dealing with Terraform tool configuration.
Authors:
Schalk W. Cronjé

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.util.Optional<java.io.File>`	`createPluginCacheDir(Project project)` Creates the plugin cache directory if it is not a global configuration.
	`static java.util.Optional<java.io.File>`	`createPluginCacheDir(TerraformRCExtension terraformrc)` Creates the plugin cache directory if it is not a global configuration.
	`static java.lang.String`	`locateGlobalTerraformConfigAsString()` Locates the global `terraformrc file`
	`static java.io.File`	`locateTerraformConfigFile(Project project)` Locates the Terraform configuration file in use by the specific project
	`static java.io.File`	`locateTerraformConfigFile(TerraformRCExtension terraformrc)` Locates the Terraform configuration file in use by the specific project
	`static TerraformRCExtension`	`locateTerraformRCExtension(Project project)` Locates the TerraformRCExtension in the project
	`static Task`	`locateTerraformRCGenerator(Project project)` Locates the task that can generate a `terraformrc` file.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Method Detail
  - @java.lang.Deprecated static java.util.Optional<java.io.File> createPluginCacheDir(Project project)
    
    Creates the plugin cache directory if it is not a global configuration.
    deprecated:
    
    Parameters:
    project - Project from which this is called.
    Returns:
    Location of the cache directory or empty if a global configuration is used.
    Throws:
    MissingTerraformConfiguration if TerraformRCExtension cannot be located.
  - static java.util.Optional<java.io.File> createPluginCacheDir(TerraformRCExtension terraformrc)
    
    Creates the plugin cache directory if it is not a global configuration.
    Parameters:
    terraformrc - TerraformRCExtension.
    Returns:
    Location of the cache directory or empty if a global configuration is used.
    Throws:
    MissingTerraformConfiguration if TerraformRCExtension cannot be located.
    Since:
    0.10.0
  - static java.lang.String locateGlobalTerraformConfigAsString()
    
    Locates the global terraformrc file
    Returns:
    Location of configuration file as a string.
    Throws:
    MissingTerraformConfiguration if the location cannot be resolved.
  - @java.lang.Deprecated static java.io.File locateTerraformConfigFile(Project project)
    
    Locates the Terraform configuration file in use by the specific project
    deprecated:
    
    Parameters:
    project - Project requesting Terraform location.
    Returns:
    Location of Terraform config file. Never null.
  - static java.io.File locateTerraformConfigFile(TerraformRCExtension terraformrc)
    
    Locates the Terraform configuration file in use by the specific project
    Parameters:
    terraformrc - TerraformRCExtension.
    Returns:
    Location of Terraform config file. Never null.
  - static TerraformRCExtension locateTerraformRCExtension(Project project)
    
    Locates the TerraformRCExtension in the project Only call this method during confguration phase.
    Parameters:
    project - Project to start search from.
    Returns:
    TerraformRCExtension. Never null.
    Throws:
    MissingTerraformConfiguration if extension cannot be located.
  - static Task locateTerraformRCGenerator(Project project)
    
    Locates the task that can generate a terraformrc file. Should only be called in configuration phase.
    Parameters:
    project - Project to start search from.
    Returns:
    Task.*
    Throws:
    MissingTerraformConfiguration if task cannot be located.

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Class TerraformConfigUtils

Methods Summary

Inherited Methods Summary

Method Detail

@java.lang.Deprecated static java.util.Optional<java.io.File> createPluginCacheDir(Project project)

static java.util.Optional<java.io.File> createPluginCacheDir(TerraformRCExtension terraformrc)

static java.lang.String locateGlobalTerraformConfigAsString()

@java.lang.Deprecated static java.io.File locateTerraformConfigFile(Project project)

static java.io.File locateTerraformConfigFile(TerraformRCExtension terraformrc)

static TerraformRCExtension locateTerraformRCExtension(Project project)

static Task locateTerraformRCGenerator(Project project)