OpenTofuSourceSet (opentofu-base-plugin 2.0.0-alpha.5 API)

org.ysb33r.gradle.opentofu.OpenTofuSourceSet

@groovy.transform.CompileStatic
class OpenTofuSourceSet
extends org.ysb33r.gradle.iac.base.tf.SourceSetBase

Describes an OpenTofu source set.

Authors:: Schalk W. Cronjé

Since:: 2.0

Field Summary

Fields
Modifiers	Name	Description
`static String`	`DEFAULT_WORKSPACE`

Inherited fields
Fields inherited from class	Fields
`class org.ysb33r.gradle.iac.base.tf.SourceSetBase`	`__$stMC`

Constructor Summary

Constructors
Constructor and description
`OpenTofuSourceSet (String name, OpenTofuExtension parent, Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`createWorkspaceTasks(String workspaceName)` Invoked when a workspace is added.
	`Provider<File>`	`getExecutableLocation()` Location of the executable that will used for this source set
	`Provider<String>`	`getExecutableVersion()` Version of the executable that will used for this source set
	`protected TaskProvider<org.ysb33r.gradle.iac.base.tf.tasks.AbstractOutputJsonTask>`	`getOutputTask(String workspaceName)`
	`Provider<File>`	`getPluginDir()` Cache directory for plugins / providers.
	`Provider<Integer>`	`getPluginDirTimeout()` Local timeout for the cache directory for plugins / providers.
	`protected java.util.List<String>`	`getRelationshipTaskNames(String ws)` Names of tasks that are important in inter-source set relationships.
	`protected NamedDomainObjectContainer<? extends org.ysb33r.gradle.iac.base.tf.SourceSetBase>`	`getSourceSetContainer()` Get access to the container this source set belongs too.
	`void`	`useBackend(String name)` Looks up a backend by name and then set this sourceset to use that backend.
	`void`	`useConfiguredPluginCache()` Use the plugin cache directory that is configured in the global configuration of the root project.
	`protected void`	`useThisCustomCacheDir(Provider<File> dir, Provider<Integer> timeout)` Use this custom cache directory.
	`void`	`useToolchain(String name)` Which toolchain to use.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.ysb33r.gradle.iac.base.tf.SourceSetBase`	org.ysb33r.gradle.iac.base.tf.SourceSetBase#getDataDir(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#secretVariable(java.lang.String, java.lang.Object), org.ysb33r.gradle.iac.base.tf.SourceSetBase#secretPropertyOrBlank(java.lang.String, java.lang.String), org.ysb33r.gradle.iac.base.tf.SourceSetBase#secretProperty(java.lang.String, java.lang.String), org.ysb33r.gradle.iac.base.tf.SourceSetBase#fromSecretsProvider(org.gradle.api.provider.Provider), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getSecretVariables(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getLogDir(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#setDataDir(java.lang.Object), org.ysb33r.gradle.iac.base.tf.SourceSetBase#setLogDir(java.lang.Object), org.ysb33r.gradle.iac.base.tf.SourceSetBase#workspaces([Ljava.lang.String;), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getSourceSetRelationshipTasks(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#secondarySources(java.lang.Iterable), org.ysb33r.gradle.iac.base.tf.SourceSetBase#secondarySources([Ljava.lang.Object;), org.ysb33r.gradle.iac.base.tf.SourceSetBase#executionOptions(org.gradle.api.Action), org.ysb33r.gradle.iac.base.tf.SourceSetBase#executionOptions(groovy.lang.Closure), org.ysb33r.gradle.iac.base.tf.SourceSetBase#setSrcDir(java.lang.Object), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getVariablesFile(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getAllVariablesFiles(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getEscapedVariables(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getBackendConfigurationDir(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getSecondarySources(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#executionOptionsFor(java.lang.Iterable), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getExecutionOptions(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#hasWorkspaces(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getBackendTokenProvider(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#rawOutputVariables(java.lang.String), org.ysb33r.gradle.iac.base.tf.SourceSetBase#rawOutputVariables(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#rawOutputVariable(java.lang.String), org.ysb33r.gradle.iac.base.tf.SourceSetBase#rawOutputVariable(java.lang.String, java.lang.String), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getPluginDir(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getPluginDirTimeout(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#useConfiguredPluginCache(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#useCustomPluginCache(java.lang.Object, java.lang.Integer), org.ysb33r.gradle.iac.base.tf.SourceSetBase#useCustomPluginCache(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#useBackend(java.lang.String), org.ysb33r.gradle.iac.base.tf.SourceSetBase#useToolchain(java.lang.String), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getWorkspaceNames(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#mustRunAfter([Ljava.lang.String;), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getVariables(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getEnvironment(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#variables(groovy.lang.Closure), org.ysb33r.gradle.iac.base.tf.SourceSetBase#variables(org.gradle.api.Action), org.ysb33r.gradle.iac.base.tf.SourceSetBase#pfaccess$0(org.ysb33r.gradle.iac.base.tf.SourceSetBase), org.ysb33r.gradle.iac.base.tf.SourceSetBase#addEnvironmentProvider(org.gradle.api.provider.Provider), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getReportsDir(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#setReportsDir(java.lang.Object), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getName(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#environment(java.util.Map), org.ysb33r.gradle.iac.base.tf.SourceSetBase#environment(java.lang.String, java.lang.Object), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getSrcDir(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getIncludes(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#setIncludes(java.lang.Iterable), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getExcludes(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#setExcludes(java.lang.Iterable), org.ysb33r.gradle.iac.base.tf.SourceSetBase#exclude([Ljava.lang.String;), org.ysb33r.gradle.iac.base.tf.SourceSetBase#exclude(org.gradle.api.specs.Spec), org.ysb33r.gradle.iac.base.tf.SourceSetBase#exclude(java.lang.Iterable), org.ysb33r.gradle.iac.base.tf.SourceSetBase#exclude(groovy.lang.Closure), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getMetaClass(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#setMetaClass(groovy.lang.MetaClass), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getAsFileTree(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#include(org.gradle.api.specs.Spec), org.ysb33r.gradle.iac.base.tf.SourceSetBase#include(java.lang.Iterable), org.ysb33r.gradle.iac.base.tf.SourceSetBase#include(groovy.lang.Closure), org.ysb33r.gradle.iac.base.tf.SourceSetBase#include([Ljava.lang.String;), org.ysb33r.gradle.iac.base.tf.SourceSetBase#equals(java.lang.Object), org.ysb33r.gradle.iac.base.tf.SourceSetBase#toString(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#hashCode(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getClass(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#notify(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#notifyAll(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#wait(long), org.ysb33r.gradle.iac.base.tf.SourceSetBase#wait(long, int), org.ysb33r.gradle.iac.base.tf.SourceSetBase#wait(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getExecutableVersion(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getExecutableLocation(), org.ysb33r.gradle.iac.base.tf.SourceSetBase#getProperty(java.lang.String), org.ysb33r.gradle.iac.base.tf.SourceSetBase#setProperty(java.lang.String, java.lang.Object), org.ysb33r.gradle.iac.base.tf.SourceSetBase#invokeMethod(java.lang.String, java.lang.Object)

- Field Detail
  - public static final String DEFAULT_WORKSPACE
- Constructor Detail
  - @javax.inject.Inject OpenTofuSourceSet(String name, OpenTofuExtension parent, Project project)
- Method Detail
  - @Override protected void createWorkspaceTasks(String workspaceName)
    
    Invoked when a workspace is added.
    Parameters:
    workspaceName - Name of workspace,
  - @Override Provider<File> getExecutableLocation()
    
    Location of the executable that will used for this source set
    Returns:
    Provider to the executable
  - @Override Provider<String> getExecutableVersion()
    
    Version of the executable that will used for this source set
    Returns:
    Provider to the version.
  - @Override protected TaskProvider<org.ysb33r.gradle.iac.base.tf.tasks.AbstractOutputJsonTask> getOutputTask(String workspaceName)
  - @Override Provider<File> getPluginDir()
    
    Cache directory for plugins / providers.
    Returns:
    Location of plugin directory.
  - @Override Provider<Integer> getPluginDirTimeout()
    
    Local timeout for the cache directory for plugins / providers.
    Returns:
    Timeout in milliseconds. If less than 1, then no lock will be performed
  - @Override protected java.util.List<String> getRelationshipTaskNames(String ws)
    
    Names of tasks that are important in inter-source set relationships.
    Parameters:
    ws - Name of workspace.
    Returns:
    List of task names.
  - @Override protected NamedDomainObjectContainer<? extends org.ysb33r.gradle.iac.base.tf.SourceSetBase> getSourceSetContainer()
    
    Get access to the container this source set belongs too.
    Returns:
    Container. Cannot be null.
  - @Override void useBackend(String name)
    
    Looks up a backend by name and then set this sourceset to use that backend.
    Parameters:
    name - Name of backend.
  - @Override void useConfiguredPluginCache()
    
    Use the plugin cache directory that is configured in the global configuration of the root project.
  - @Override protected void useThisCustomCacheDir(Provider<File> dir, Provider<Integer> timeout)
    
    Use this custom cache directory.
    Parameters:
    dir - Location of cache.
    timeout - Timeout in milliseconds.
  - @Override void useToolchain(String name)
    
    Which toolchain to use.
    If not called, it will always used a default toolchain.
    
    Parameters:
    name - Name of toolchain.

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class OpenTofuSourceSet

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String DEFAULT_WORKSPACE

Constructor Detail

@javax.inject.Inject OpenTofuSourceSet(String name, OpenTofuExtension parent, Project project)

Method Detail

@Override protected void createWorkspaceTasks(String workspaceName)

@Override Provider<File> getExecutableLocation()

@Override Provider<String> getExecutableVersion()

@Override protected TaskProvider<org.ysb33r.gradle.iac.base.tf.tasks.AbstractOutputJsonTask> getOutputTask(String workspaceName)

@Override Provider<File> getPluginDir()

@Override Provider<Integer> getPluginDirTimeout()

@Override protected java.util.List<String> getRelationshipTaskNames(String ws)

@Override protected NamedDomainObjectContainer<? extends org.ysb33r.gradle.iac.base.tf.SourceSetBase> getSourceSetContainer()

@Override void useBackend(String name)

@Override void useConfiguredPluginCache()

@Override protected void useThisCustomCacheDir(Provider<File> dir, Provider<Integer> timeout)

@Override void useToolchain(String name)