TerraformSourceDirectorySet (Jobble Gradle Plugin Suite Combined API 0.11.3)

org.ysb33r.gradle.terraform.TerraformSourceDirectorySet

All Implemented Interfaces and Traits:: PatternFilterable

@groovy.transform.CompileStatic
@java.lang.SuppressWarnings('MethodCount')
class TerraformSourceDirectorySet

Describes a Terraform source set

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`TerraformSourceDirectorySet.Workspace`

Properties Summary

Properties
Type	Name and description
`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`
`Provider<java.io.File>`	`logDir`
`java.lang.String`	`name` Source directory name
`Provider<java.io.File>`	`reportsDir`
`Provider<java.io.File>`	`srcDir`

Constructor Summary

Constructors
Constructor and description
`TerraformSourceDirectorySet (Project tempProjectReference, ObjectFactory objects, TaskContainer tasks, TerraformRCExtension terraformrc, java.lang.String name, java.lang.String displayName)` Constructs the source set.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`PatternFilterable`	`exclude(groovy.lang.Closure closure)`
	`PatternFilterable`	`exclude(Spec<FileTreeElement> spec)`
	`PatternFilterable`	`exclude(java.lang.String... strings)`
	`PatternFilterable`	`exclude(java.lang.Iterable<java.lang.String> iterable)`
	`FileTree`	`getAsFileTree()` Returns terraform source tree
	`Provider<java.util.Set<SessionCredentials>>`	`getCredentialProviders(java.lang.String wsName = DEFAULT_WORKSPACE)` Returns the credential providers on a per workspace basis.
	`Provider<java.io.File>`	`getDataDir()` Data directory provider.
	`java.util.Set<java.lang.String>`	`getExcludes()`
	`PatternFilterable`	`getFilter()` Returns the pattern filter.
	`java.util.Set<java.lang.String>`	`getIncludes()`
	`Provider<java.io.File>`	`getLogDir()` Log directory provider.
	`Provider<java.util.Map<java.lang.String, ?>>`	`getRawOutputVariables(java.lang.String workspaceName = DEFAULT_WORKSPACE)` Returns a provider which can be used to access output variables from a source set.
	`Provider<java.io.File>`	`getReportsDir()` Reports directory.
	`Provider<java.util.List<java.io.File>>`	`getSecondarySources()` Provides a list of secondary sources.
	`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.
	`java.util.List<java.lang.String>`	`getWorkspaceNames()` List of additional workspaces.
	`boolean`	`hasWorkspaces()` Flags whether workspaces have been defined.
	`PatternFilterable`	`include(java.lang.String... strings)`
	`PatternFilterable`	`include(java.lang.Iterable<java.lang.String> iterable)`
	`PatternFilterable`	`include(Spec<FileTreeElement> spec)`
	`PatternFilterable`	`include(groovy.lang.Closure closure)`
	`Provider<java.lang.Object>`	`rawOutputVariable(java.lang.String varName, java.lang.String workspaceName = DEFAULT_WORKSPACE)` Returns a provider to a specific output variable.
	`void`	`registerCredentialProvider(SessionCredentialsProvider provider)` Registers a credentials provider.
	`void`	`secondarySources(java.lang.Object... files)` Additional sources that affects infrastructure.
	`void`	`secondarySources(java.lang.Iterable<java.lang.Object> files)` Additional sources that affects infrastructure.
	`void`	`setDataDir(java.lang.Object dir)` Sets the Terraform data directory.
	`PatternFilterable`	`setExcludes(java.lang.Iterable<java.lang.String> iterable)`
	`PatternFilterable`	`setIncludes(java.lang.Iterable<java.lang.String> iterable)`
	`void`	`setLogDir(java.lang.Object dir)` Sets the log directory.
	`void`	`setReportsDir(java.lang.Object dir)` Sets the reports directory.
	`void`	`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(Action<VariablesSpec> cfg)` Sets Terraform variables that are applicable to this source set.
	`void`	`workspaces(java.lang.String... workspaceNames)` Adds one or more workspaces.

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
  - 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
  - Provider<java.io.File> logDir
  - final java.lang.String name
    
    Source directory name
  - Provider<java.io.File> reportsDir
  - Provider<java.io.File> srcDir
- Constructor Detail
  - @Inject @java.lang.SuppressWarnings(['ParameterCount', 'MethodSize']) TerraformSourceDirectorySet(Project tempProjectReference, ObjectFactory objects, TaskContainer tasks, TerraformRCExtension terraformrc, java.lang.String name, java.lang.String displayName)
    
    Constructs the source set.
    Parameters:
    tempProjectReference - Project this source set is attached to.
    object - Object factory
    tasks - Take container
    terraformrc - Reference to TerraformRCExtension
    name - Name of source set.
    displayName - Display name of source set.
- Method Detail
  - @java.lang.Override PatternFilterable exclude(groovy.lang.Closure closure)
  - @java.lang.Override PatternFilterable exclude(Spec<FileTreeElement> spec)
  - @java.lang.Override PatternFilterable exclude(java.lang.String... strings)
  - @java.lang.Override PatternFilterable exclude(java.lang.Iterable<java.lang.String> iterable)
  - FileTree getAsFileTree()
    
    Returns terraform source tree
    Returns:
    Source tree as a file tree.
  - Provider<java.util.Set<SessionCredentials>> getCredentialProviders(java.lang.String wsName = DEFAULT_WORKSPACE)
    
    Returns the credential providers on a per workspace basis.
    Parameters:
    Name - of workspace. Defaults to default is not supplied.
    Returns:
    Set of credentials for a specific workspace.
    Since:
    0.11
  - Provider<java.io.File> getDataDir()
    
    Data directory provider.
    Returns:
    File provider.
  - @java.lang.Override java.util.Set<java.lang.String> getExcludes()
  - PatternFilterable getFilter()
    
    Returns the pattern filter.
    Returns:
    Terraform pattern filter.
  - @java.lang.Override java.util.Set<java.lang.String> getIncludes()
  - Provider<java.io.File> getLogDir()
    
    Log directory provider.
    Returns:
    File provider.
  - Provider<java.util.Map<java.lang.String, ?>> getRawOutputVariables(java.lang.String workspaceName = DEFAULT_WORKSPACE)
    
    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.
    Parameters:
    workspaceName - which workspace this is for. Defaults to default workspace if not supplied.
    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
  - Provider<java.io.File> getReportsDir()
    
    Reports directory.
    Returns:
    File provider.
  - Provider<java.util.List<java.io.File>> getSecondarySources()
    
    Provides a list of secondary sources.
    Returns:
    Provider never returns null, but could return an empty list.
  - 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.util.List<java.lang.String> getWorkspaceNames()
    
    List of additional workspaces.
    Returns:
    Names of workspaces other than default.
    Since:
    0.10.0
  - boolean hasWorkspaces()
    
    Flags whether workspaces have been defined.
    Returns:
    true is one or more workspaces have been defined
    Since:
    0.10.0
  - @java.lang.Override PatternFilterable include(java.lang.String... strings)
  - @java.lang.Override PatternFilterable include(java.lang.Iterable<java.lang.String> iterable)
  - @java.lang.Override PatternFilterable include(Spec<FileTreeElement> spec)
  - @java.lang.Override PatternFilterable include(groovy.lang.Closure closure)
  - Provider<java.lang.Object> rawOutputVariable(java.lang.String varName, java.lang.String workspaceName = DEFAULT_WORKSPACE)
    
    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.
    Parameters:
    varName - Name of specific variable.
    workspaceName - which workspace this is for. Defaults to default workspace if not supplied.
    Returns:
    Provider for value of specific output variable. If the variable is not a primitive type, it is up to the caller to do further processing,
    Since:
    0.9.0
  - void registerCredentialProvider(SessionCredentialsProvider provider)
    
    Registers a credentials provider.
    Parameters:
    provider - New credentials provider.
    Since:
    0.11
  - void secondarySources(java.lang.Object... files)
    
    Additional sources that affects infrastructure.
    Parameters:
    files - Anything convertible to a file.
    Since:
    0.10.
  - void secondarySources(java.lang.Iterable<java.lang.Object> files)
    
    Additional sources that affects infrastructure.
    Parameters:
    files - Anything convertible to a file.
    Since:
    0.10.
  - void setDataDir(java.lang.Object dir)
    
    Sets the Terraform data directory.
    Parameters:
    dir - Directory can be anything convertible using Project#file#file.
    Returns:
    this.
  - @java.lang.Override PatternFilterable setExcludes(java.lang.Iterable<java.lang.String> iterable)
  - @java.lang.Override PatternFilterable setIncludes(java.lang.Iterable<java.lang.String> iterable)
  - void setLogDir(java.lang.Object dir)
    
    Sets the log directory.
    Parameters:
    dir - Directory can be anything convertible using Project#file#file.
    Returns:
    this.
  - void setReportsDir(java.lang.Object dir)
    
    Sets the reports directory.
    Parameters:
    dir - Directory can be anything convertible using Project#file#file.
    Returns:
    this.
  - void setSrcDir(java.lang.Object dir)
    
    Sets the source directory.
    Parameters:
    dir - Directory can be anything convertible using Project#file#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(Action<VariablesSpec> cfg)
    
    Sets Terraform variables that are applicable to this source set.
    Parameters:
    cfg - Configurating action.
    Since:
    0.2
  - void workspaces(java.lang.String... workspaceNames)
    
    Adds one or more workspaces.
    Since:
    0.10.0

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class TerraformSourceDirectorySet

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Provider<java.io.File> dataDir

final java.lang.String displayName

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

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

Provider<java.io.File> logDir

final java.lang.String name

Provider<java.io.File> reportsDir

Provider<java.io.File> srcDir

Constructor Detail

@Inject @java.lang.SuppressWarnings(['ParameterCount', 'MethodSize']) TerraformSourceDirectorySet(Project tempProjectReference, ObjectFactory objects, TaskContainer tasks, TerraformRCExtension terraformrc, java.lang.String name, java.lang.String displayName)

Method Detail

@java.lang.Override PatternFilterable exclude(groovy.lang.Closure closure)

@java.lang.Override PatternFilterable exclude(Spec<FileTreeElement> spec)

@java.lang.Override PatternFilterable exclude(java.lang.String... strings)

@java.lang.Override PatternFilterable exclude(java.lang.Iterable<java.lang.String> iterable)

FileTree getAsFileTree()

Provider<java.util.Set<SessionCredentials>> getCredentialProviders(java.lang.String wsName = DEFAULT_WORKSPACE)

Provider<java.io.File> getDataDir()

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

PatternFilterable getFilter()

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

Provider<java.io.File> getLogDir()

Provider<java.util.Map<java.lang.String, ?>> getRawOutputVariables(java.lang.String workspaceName = DEFAULT_WORKSPACE)

Provider<java.io.File> getReportsDir()

Provider<java.util.List<java.io.File>> getSecondarySources()

Provider<java.io.File> getSrcDir()

VariablesSpec getVariables()

java.util.List<java.lang.String> getWorkspaceNames()

boolean hasWorkspaces()

@java.lang.Override PatternFilterable include(java.lang.String... strings)

@java.lang.Override PatternFilterable include(java.lang.Iterable<java.lang.String> iterable)

@java.lang.Override PatternFilterable include(Spec<FileTreeElement> spec)

@java.lang.Override PatternFilterable include(groovy.lang.Closure closure)

Provider<java.lang.Object> rawOutputVariable(java.lang.String varName, java.lang.String workspaceName = DEFAULT_WORKSPACE)

void registerCredentialProvider(SessionCredentialsProvider provider)

void secondarySources(java.lang.Object... files)

void secondarySources(java.lang.Iterable<java.lang.Object> files)

void setDataDir(java.lang.Object dir)

@java.lang.Override PatternFilterable setExcludes(java.lang.Iterable<java.lang.String> iterable)

@java.lang.Override PatternFilterable setIncludes(java.lang.Iterable<java.lang.String> iterable)

void setLogDir(java.lang.Object dir)

void setReportsDir(java.lang.Object dir)

void 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(Action<VariablesSpec> cfg)

void workspaces(java.lang.String... workspaceNames)