TerraformSourceDirectorySet (terraform-gradle-plugin 0.9.0 API)

org.ysb33r.gradle.terraform.TerraformSourceDirectorySet

All Implemented Interfaces and Traits:

org.gradle.api.tasks.util.PatternFilterable
```
@groovy.transform.CompileStatic
class TerraformSourceDirectorySet
extends java.lang.Object
```
Describes a Terraform source set

Properties Summary

Properties
Type	Name and description
`org.gradle.api.provider.Provider<java.io.File>`	`dataDir`
`java.lang.String`	`displayName` Displayable name of source set.
`java.util.Set<java.lang.String>`	`excludes`
`java.util.Set<java.lang.String>`	`includes`
`org.gradle.api.provider.Provider<java.io.File>`	`logDir`
`java.lang.String`	`name` Source directory name
`org.gradle.api.provider.Provider<java.io.File>`	`reportsDir`
`org.gradle.api.provider.Provider<java.io.File>`	`srcDir`

Constructor Summary

Constructors
Constructor and description
`TerraformSourceDirectorySet (org.gradle.api.Project project, java.lang.String name, java.lang.String displayName)` Constructs the source set.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`org.gradle.api.tasks.util.PatternFilterable`	`exclude(groovy.lang.Closure closure)`
	`org.gradle.api.tasks.util.PatternFilterable`	`exclude(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> spec)`
	`org.gradle.api.tasks.util.PatternFilterable`	`exclude(java.lang.String... strings)`
	`org.gradle.api.tasks.util.PatternFilterable`	`exclude(java.lang.Iterable<java.lang.String> iterable)`
	`org.gradle.api.file.FileTree`	`getAsFileTree()` Returns terraform source tree
	`org.gradle.api.provider.Provider<java.io.File>`	`getDataDir()` Data directory provider.
	`java.util.Set<java.lang.String>`	`getExcludes()`
	`org.gradle.api.tasks.util.PatternFilterable`	`getFilter()` Returns the pattern filter.
	`java.util.Set<java.lang.String>`	`getIncludes()`
	`org.gradle.api.provider.Provider<java.io.File>`	`getLogDir()` Log directory provider.
	`org.gradle.api.provider.Provider<java.util.Map<java.lang.String, ?>>`	`getRawOutputVariables()` Returns a provider which can be used to access output variables from a source set.
	`org.gradle.api.provider.Provider<java.io.File>`	`getReportsDir()` Reports directory.
	`org.gradle.api.provider.Provider<java.io.File>`	`getSrcDir()` Provide for the root directory of the source set,
	`VariablesSpec`	`getVariables()` Get all terraform variables applicable to this source set.
	`org.gradle.api.tasks.util.PatternFilterable`	`include(java.lang.String... strings)`
	`org.gradle.api.tasks.util.PatternFilterable`	`include(java.lang.Iterable<java.lang.String> iterable)`
	`org.gradle.api.tasks.util.PatternFilterable`	`include(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> spec)`
	`org.gradle.api.tasks.util.PatternFilterable`	`include(groovy.lang.Closure closure)`
	`org.gradle.api.provider.Provider<java.lang.Object>`	`rawOutputVariable(java.lang.String varName)` Returns a provider to a specific output variable.
	`TerraformSourceDirectorySet`	`setDataDir(java.lang.Object dir)` Sets the Terraform data directory.
	`org.gradle.api.tasks.util.PatternFilterable`	`setExcludes(java.lang.Iterable<java.lang.String> iterable)`
	`org.gradle.api.tasks.util.PatternFilterable`	`setIncludes(java.lang.Iterable<java.lang.String> iterable)`
	`TerraformSourceDirectorySet`	`setLogDir(java.lang.Object dir)` Sets the log directory.
	`TerraformSourceDirectorySet`	`setReportsDir(java.lang.Object dir)` Sets the reports directory.
	`TerraformSourceDirectorySet`	`setSrcDir(java.lang.Object dir)` Sets the source directory.
	`java.lang.String`	`terraformPath(java.lang.Object file)` Converts a file path to a format suitable for interpretation by Terraform on the appropriate platform.
	`java.lang.String`	`toString()` The display name is the string representation of the source set.
	`void`	`variables(groovy.lang.Closure cfg)` Sets Terraform variables that are applicable to this source set.
	`void`	`variables(org.gradle.api.Action<VariablesSpec> cfg)` Sets Terraform variables that are applicable to this source set.

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()`

- Property Detail
  - org.gradle.api.provider.Provider<java.io.File> dataDir
  - final java.lang.String displayName
    
    Displayable name of source set.
  - java.util.Set<java.lang.String> excludes
  - java.util.Set<java.lang.String> includes
  - org.gradle.api.provider.Provider<java.io.File> logDir
  - final java.lang.String name
    
    Source directory name
  - org.gradle.api.provider.Provider<java.io.File> reportsDir
  - org.gradle.api.provider.Provider<java.io.File> srcDir
- Constructor Detail
  - TerraformSourceDirectorySet(org.gradle.api.Project project, java.lang.String name, java.lang.String displayName)
    
    Constructs the source set.
    Parameters:
    project - Project this sourcer set is attached to.
    name - Name of source set.
    displayName - Display name of source set.
- Method Detail
  - @java.lang.Override org.gradle.api.tasks.util.PatternFilterable exclude(groovy.lang.Closure closure)
  - @java.lang.Override org.gradle.api.tasks.util.PatternFilterable exclude(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> spec)
  - @java.lang.Override org.gradle.api.tasks.util.PatternFilterable exclude(java.lang.String... strings)
  - @java.lang.Override org.gradle.api.tasks.util.PatternFilterable exclude(java.lang.Iterable<java.lang.String> iterable)
  - org.gradle.api.file.FileTree getAsFileTree()
    
    Returns terraform source tree
    Returns:
    SOurce tree as a file tree.
  - org.gradle.api.provider.Provider<java.io.File> getDataDir()
    
    Data directory provider.
    Returns:
    File provider.
  - @java.lang.Override java.util.Set<java.lang.String> getExcludes()
  - org.gradle.api.tasks.util.PatternFilterable getFilter()
    
    Returns the pattern filter.
    Returns:
    Terraform pattern filter.
  - @java.lang.Override java.util.Set<java.lang.String> getIncludes()
  - org.gradle.api.provider.Provider<java.io.File> getLogDir()
    
    Log directory provider.
    Returns:
    File provider.
  - org.gradle.api.provider.Provider<java.util.Map<java.lang.String, ?>> getRawOutputVariables()
    
    Returns a provider which can be used to access output variables from a source set. Invoking the provider return by this call will invoke terraform output the first time, but thereafter values will be cached for the remainder of of the build. If you want updates values, ensure the relavent TerraformApply task is run before invoking the provider.
    Returns:
    Provider for reading output values. THe values are returned in a raw format which basically is just the JSON output parsed into some form of map.
    Since:
    0.9.0
  - org.gradle.api.provider.Provider<java.io.File> getReportsDir()
    
    Reports directory.
    Returns:
    File provider.
  - org.gradle.api.provider.Provider<java.io.File> getSrcDir()
    
    Provide for the root directory of the source set,
    Returns:
    File provider.
  - VariablesSpec getVariables()
    
    Get all terraform variables applicable to this source set.
    Parameters:
    cfg
    Since:
    0.2
  - @java.lang.Override org.gradle.api.tasks.util.PatternFilterable include(java.lang.String... strings)
  - @java.lang.Override org.gradle.api.tasks.util.PatternFilterable include(java.lang.Iterable<java.lang.String> iterable)
  - @java.lang.Override org.gradle.api.tasks.util.PatternFilterable include(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> spec)
  - @java.lang.Override org.gradle.api.tasks.util.PatternFilterable include(groovy.lang.Closure closure)
  - org.gradle.api.provider.Provider<java.lang.Object> rawOutputVariable(java.lang.String varName)
    
    Returns a provider to a specific output variable. Invoking the provider return by this call will invoke terraform output the first time, but thereafter values will be cached for the remainder of of the build. If you want updates values, ensure the relavent TerraformApply task is run before invoking the provider.
    Returns:
    Provider for value of specific output variable. If the vairable is not a primitive type, it is up to the caller to do further processing,
    Since:
    0.9.0
  - TerraformSourceDirectorySet setDataDir(java.lang.Object dir)
    
    Sets the Terraform data directory.
    Parameters:
    dir - Directory can be anything convertible using org.gradle.api.Project#file.
    Returns:
    this.
  - @java.lang.Override org.gradle.api.tasks.util.PatternFilterable setExcludes(java.lang.Iterable<java.lang.String> iterable)
  - @java.lang.Override org.gradle.api.tasks.util.PatternFilterable setIncludes(java.lang.Iterable<java.lang.String> iterable)
  - TerraformSourceDirectorySet setLogDir(java.lang.Object dir)
    
    Sets the log directory.
    Parameters:
    dir - Directory can be anything convertible using org.gradle.api.Project#file.
    Returns:
    this.
  - TerraformSourceDirectorySet setReportsDir(java.lang.Object dir)
    
    Sets the reports directory.
    Parameters:
    dir - Directory can be anything convertible using org.gradle.api.Project#file.
    Returns:
    this.
  - TerraformSourceDirectorySet setSrcDir(java.lang.Object dir)
    
    Sets the source directory.
    Parameters:
    dir - Directory can be anything convertible using org.gradle.api.Project#file.
    Returns:
    this.
  - 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.Override java.lang.String toString()
    
    The display name is the string representation of the source set.
    Returns:
    String representation
  - void variables(@groovy.lang.DelegatesTo(VariablesSpec) groovy.lang.Closure cfg)
    
    Sets Terraform variables that are applicable to this source set.
    Parameters:
    cfg - Closure that configures a VariablesSpec.
    Since:
    0.2
  - void variables(org.gradle.api.Action<VariablesSpec> cfg)
    
    Sets Terraform variables that are applicable to this source set.
    Parameters:
    cfg - Configurating action.
    Since:
    0.2

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class TerraformSourceDirectorySet

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

org.gradle.api.provider.Provider<java.io.File> dataDir

final java.lang.String displayName

java.util.Set<java.lang.String> excludes

java.util.Set<java.lang.String> includes

org.gradle.api.provider.Provider<java.io.File> logDir

final java.lang.String name

org.gradle.api.provider.Provider<java.io.File> reportsDir

org.gradle.api.provider.Provider<java.io.File> srcDir

Constructor Detail

TerraformSourceDirectorySet(org.gradle.api.Project project, java.lang.String name, java.lang.String displayName)

Method Detail

@java.lang.Override org.gradle.api.tasks.util.PatternFilterable exclude(groovy.lang.Closure closure)

@java.lang.Override org.gradle.api.tasks.util.PatternFilterable exclude(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> spec)

@java.lang.Override org.gradle.api.tasks.util.PatternFilterable exclude(java.lang.String... strings)

@java.lang.Override org.gradle.api.tasks.util.PatternFilterable exclude(java.lang.Iterable<java.lang.String> iterable)

org.gradle.api.file.FileTree getAsFileTree()

org.gradle.api.provider.Provider<java.io.File> getDataDir()

@java.lang.Override java.util.Set<java.lang.String> getExcludes()

org.gradle.api.tasks.util.PatternFilterable getFilter()

@java.lang.Override java.util.Set<java.lang.String> getIncludes()

org.gradle.api.provider.Provider<java.io.File> getLogDir()

org.gradle.api.provider.Provider<java.util.Map<java.lang.String, ?>> getRawOutputVariables()

org.gradle.api.provider.Provider<java.io.File> getReportsDir()

org.gradle.api.provider.Provider<java.io.File> getSrcDir()

VariablesSpec getVariables()

@java.lang.Override org.gradle.api.tasks.util.PatternFilterable include(java.lang.String... strings)

@java.lang.Override org.gradle.api.tasks.util.PatternFilterable include(java.lang.Iterable<java.lang.String> iterable)

@java.lang.Override org.gradle.api.tasks.util.PatternFilterable include(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> spec)

@java.lang.Override org.gradle.api.tasks.util.PatternFilterable include(groovy.lang.Closure closure)

org.gradle.api.provider.Provider<java.lang.Object> rawOutputVariable(java.lang.String varName)

TerraformSourceDirectorySet setDataDir(java.lang.Object dir)

@java.lang.Override org.gradle.api.tasks.util.PatternFilterable setExcludes(java.lang.Iterable<java.lang.String> iterable)

@java.lang.Override org.gradle.api.tasks.util.PatternFilterable setIncludes(java.lang.Iterable<java.lang.String> iterable)

TerraformSourceDirectorySet setLogDir(java.lang.Object dir)

TerraformSourceDirectorySet setReportsDir(java.lang.Object dir)

TerraformSourceDirectorySet setSrcDir(java.lang.Object dir)

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

@java.lang.Override java.lang.String toString()

void variables(@groovy.lang.DelegatesTo(VariablesSpec) groovy.lang.Closure cfg)

void variables(org.gradle.api.Action<VariablesSpec> cfg)