Index (iac-base-plugin 2.4.2 API)

A B E F G I L M N O P R S T U V
All Classes All Packages

A

addTasksToLifecycleTask(String, Iterable<String>) - Method in class org.ysb33r.gradle.iac.base.internal.tf.TaskSetResolver: Registers a collection of tasks with a lifecycle task.
addTokenProvider(Provider<Map<String, TokenValue>>) - Method in interface org.ysb33r.gradle.iac.base.tf.backends.TokenConfiguration: Adds a provider of tokens.

B

BackendConfigOverrides - Interface in org.ysb33r.gradle.iac.base.tf.backends: Indicates which backend configuration should be sent via the command-line rather than the backend configuration file or secret environment variables.
BasicSourceSetExecutionEnvironment - Interface in org.ysb33r.gradle.iac.base.tf: Provide the default executable and environment associated with a source set or module source set.

E

eachModule(Action<T>) - Method in interface org.ysb33r.gradle.iac.base.tf.modules.ModulePublishTarget: Configure each module linked to this publisher.
ExecutionConfiguration - Interface in org.ysb33r.gradle.iac.base.tf.config.multilevel: An extension that can be added to a task for representing a specific grouping of Terraform command-line parameters.
executionOptionsFor(Iterable<Class<? extends ExecutionConfiguration>>) - Method in interface org.ysb33r.gradle.iac.base.tf.SourceSetExecutionEnvironment: The execution options configured on the toolchain.

F

file(Object) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Deprecated.
USe VariablesSpec.files(java.lang.Object...) instead.
files(Object...) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Adds one or more file names containing terraform variables.
fileToken(String, Object) - Method in interface org.ysb33r.gradle.iac.base.tf.backends.TokenConfiguration: Set a single token value.
fromSecretsProvider(Provider<Map<String, SimpleSecureString>>) - Method in interface org.ysb33r.gradle.iac.base.tf.SecretVariables: Use secrets from another provider of secrets.

G

getAllPlatforms() - Method in interface org.ysb33r.gradle.iac.base.tf.IacPlatforms: Standard set of supported platforms.
getAsEnvTfVar() - Method in interface org.ysb33r.gradle.iac.base.tf.RemoteStateVarProvider: A provider for TF variables when configured for RemoteStateInjection.ENVIRONMENT.
getAsFileTree() - Method in interface org.ysb33r.gradle.iac.base.tf.SourceSetSources: Source tree
getAsTfVar() - Method in interface org.ysb33r.gradle.iac.base.tf.RemoteStateVarProvider: A provider for TF variables when configured for RemoteStateInjection.VARIABLE.
getBackendTokenOverrides() - Method in interface org.ysb33r.gradle.iac.base.tf.backends.BackendConfigOverrides: Returns a provider to a set of variables which will be passed on the command-line as backend configuration
getCcso() - Method in class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository
getCommandLineArgs() - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.ExecutionConfiguration: Returns the list of Terraform/OpenTofu command-line arguments.
getConfigFile() - Method in interface org.ysb33r.gradle.iac.base.tf.TfConfig: Location of the global config.
getDataDir() - Method in interface org.ysb33r.gradle.iac.base.tf.SourceSetSources: Data directory provider.
getEnvironment() - Method in interface org.ysb33r.gradle.iac.base.tf.BasicSourceSetExecutionEnvironment: Provider to the full running environment.
getExecutableLocation() - Method in interface org.ysb33r.gradle.iac.base.tf.BasicSourceSetExecutionEnvironment: Location of the executable that will be used for this source set
getExecutableVersion() - Method in interface org.ysb33r.gradle.iac.base.tf.BasicSourceSetExecutionEnvironment: Version of the executable that will be used for this source set
getInjectVar() - Method in interface org.ysb33r.gradle.iac.base.tf.RemoteStateVarProvider: A provider to indicate whether remote state tokens should be injected.
getInputProperty() - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.ExecutionConfiguration: A value that is used as an input property and which can be used to signal that a task needs to be run again.
getLogDir() - Method in interface org.ysb33r.gradle.iac.base.tf.SourceSetSources: Log directory provider.
getModuleName() - Method in interface org.ysb33r.gradle.iac.base.tf.modules.ModuleDescription: The name of the module that will be used for publication.
getModuleSourceSet(String) - Method in class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository
getModuleVersion() - Method in interface org.ysb33r.gradle.iac.base.tf.modules.ModuleDescription: The version of the module.
getName() - Method in class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository: Repository name
getObjectFactory() - Method in class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository
getPlatforms() - Method in interface org.ysb33r.gradle.iac.base.tf.IacPlatforms: Provide the list of platforms that need to be supported.
getPluginCacheDir() - Method in interface org.ysb33r.gradle.iac.base.tf.PluginCache: Location of plugin cache directory.
getPluginDir() - Method in interface org.ysb33r.gradle.iac.base.tf.PluginCacheManagement: Cache directory for plugins / providers.
getPluginDirTimeout() - Method in interface org.ysb33r.gradle.iac.base.tf.PluginCacheManagement: Local timeout for the cache directory for plugins / providers.
getPrefixVersionWithV() - Method in class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository: Indicates whether the version string is prefixed with a v
getPublishTests() - Method in class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository: Whether to publish test files.
getRemoteStateMap() - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Provide access to a remote state configuration.
getReportsDir() - Method in interface org.ysb33r.gradle.iac.base.tf.SourceSetSources: Reports directory.
getRequiresLicense() - Method in class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository: Indicates whether a repository requires a license file.
getRequiresRollupAdditionalSourceFiles() - Method in class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository: Indicated whether source files other than (outputs|variables).(tf|tofu) must be rolled up into main.(tf|tofu) when publishing.
getSecondarySources() - Method in interface org.ysb33r.gradle.iac.base.tf.SourceSetSources: Provides a list of secondary sources.
getSecretVariables() - Method in interface org.ysb33r.gradle.iac.base.tf.SecretVariablesProvider: Returns a provider to a set of secret variables.
getSrcDir() - Method in interface org.ysb33r.gradle.iac.base.tf.SourceSetSources: Provide for the root directory of the source set,
getTaskContainer() - Method in class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository
getTestSubdir() - Method in interface org.ysb33r.gradle.iac.base.tf.SourceSetSources: Obtain the name of the subdirectory where tests are located.
getTfVars() - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.ExecutionConfiguration: Returns the list of variables in the form name=value
getTokenProvider() - Method in interface org.ysb33r.gradle.iac.base.tf.backends.IacBackendAttributesSpec: A provider for all the tokens that were set.
getUseLockWithTimeout() - Method in interface org.ysb33r.gradle.iac.base.tf.PluginCache: Indicates whether access to the plugin cache dir should be locked between operations that writes to the cache directory
getValue() - Method in interface org.ysb33r.gradle.iac.base.tf.backends.TokenValue
getVariablesFiles() - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.UsesVariables: The location of the variables files.

I

IacBackendAttributesSpec - Interface in org.ysb33r.gradle.iac.base.tf.backends: Attributes that describe a backend.
IacBackendSpec - Interface in org.ysb33r.gradle.iac.base.tf.backends: Describes the configuration for a backend.
IacBackendTextTemplate - Interface in org.ysb33r.gradle.iac.base.tf.backends: Represents a text template for creating a backend configuration file.
IacPlatforms - Interface in org.ysb33r.gradle.iac.base.tf: Defines the platforms that the tool is supported on.

L

list(String, Iterable<?>) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Adds a list as a variable.
list(String, Object, Object...) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Adds a list as a variable.

M

map(String, Provider<Map<String, ?>>) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Adds a map provider as a variable.
map(Map<String, ?>, String) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Adds a map as a variable.
module(String) - Method in interface org.ysb33r.gradle.iac.base.tf.modules.NoConfigurationModulePublishTarget
module(String, Action<T>) - Method in interface org.ysb33r.gradle.iac.base.tf.modules.ModulePublishTarget: Allow a module to be published to this target.
ModuleDescription - Interface in org.ysb33r.gradle.iac.base.tf.modules: Description of a module.
ModulePublisherTaskMethods - Interface in org.ysb33r.gradle.iac.base.tf.tasks: Methods that a task should implement for publishing to a repository.
ModulePublishTarget<T> - Interface in org.ysb33r.gradle.iac.base.tf.modules: Defines a configurable item that is the link between a module repository and a module.
ModuleRepository - Class in org.ysb33r.gradle.iac.base.tf.modules: Base class for implementing module repositories (targets for publishing to).
ModuleRepository(String, Project) - Constructor for class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository

N

NoConfigurationModulePublishTarget - Interface in org.ysb33r.gradle.iac.base.tf.modules: Defines a configurable item that is the link between a module repository and a module.

O

of(Object, ObjectFactory) - Static method in interface org.ysb33r.gradle.iac.base.tf.backends.TokenValue: Creates an instance from an arbitrary value.
of(Object, ConfigCacheSafeOperations) - Static method in interface org.ysb33r.gradle.iac.base.tf.backends.TokenValue: Creates an instance from an arbitrary value.
of(Object, ProviderTools) - Static method in interface org.ysb33r.gradle.iac.base.tf.backends.TokenValue: Creates an instance from an arbitrary value.
org.ysb33r.gradle.iac.base.internal.tf - package org.ysb33r.gradle.iac.base.internal.tf
org.ysb33r.gradle.iac.base.tf - package org.ysb33r.gradle.iac.base.tf
org.ysb33r.gradle.iac.base.tf.backends - package org.ysb33r.gradle.iac.base.tf.backends
org.ysb33r.gradle.iac.base.tf.config.multilevel - package org.ysb33r.gradle.iac.base.tf.config.multilevel
org.ysb33r.gradle.iac.base.tf.modules - package org.ysb33r.gradle.iac.base.tf.modules
org.ysb33r.gradle.iac.base.tf.tasks - package org.ysb33r.gradle.iac.base.tf.tasks

P

planHasDetailedExitCode() - Method in interface org.ysb33r.gradle.iac.base.tf.ToolFeatures: plan supports {-detailed-exitcode}
planHasGenerateConfigOut() - Method in interface org.ysb33r.gradle.iac.base.tf.ToolFeatures: plan supports {-generate-config-out}
planHasRefreshOnly() - Method in interface org.ysb33r.gradle.iac.base.tf.ToolFeatures: Whether plan supports -refresh-only
platforms(Iterable<String>) - Method in interface org.ysb33r.gradle.iac.base.tf.IacPlatforms: Add one or more platforms to support for providers.
platforms(String...) - Method in interface org.ysb33r.gradle.iac.base.tf.IacPlatforms: Add one or more platforms to support for providers.
PluginCache - Interface in org.ysb33r.gradle.iac.base.tf: Plugin Cache methods.
PluginCacheManagement - Interface in org.ysb33r.gradle.iac.base.tf: Methods for working with the plugin cache.
provider(Action<VariablesSpec>) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Adds additional actions which can add variables.

R

remoteStateMap(Closure<?>) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Configure the injection of a map for terraform_remote_state usage.
remoteStateMap(Action<RemoteStateVarProvider>) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Configure the injection of a map for terraform_remote_state usage.
RemoteStateVarProvider - Interface in org.ysb33r.gradle.iac.base.tf: Manages the injection of a variable containing variables related to remote state, so that they can be used by terraform_remote_state data sources.
resolveDestroyOrder(Collection<Class<? extends AbstractTfStandardTask>>, Collection<String>, Collection<String>) - Method in class org.ysb33r.gradle.iac.base.internal.tf.TaskSetResolver: Given a selection of task classes, of which the names start with the list of base names, they will be rquired to run after another set of provided tasks.
ResourceFilter - Interface in org.ysb33r.gradle.iac.base.tf: Filter resources to be replaced, updated or deleted.

S

secretProperty(String, String) - Method in interface org.ysb33r.gradle.iac.base.tf.SecretVariables: Sets a secret variable that will be injected into the environment at run time.
secretPropertyOrBlank(String, String) - Method in interface org.ysb33r.gradle.iac.base.tf.SecretVariables: Sets a secret variable that will be injected into the environment at run time.
secretVariable(String, Object) - Method in interface org.ysb33r.gradle.iac.base.tf.SecretVariables: Sets a secret variable that will be injected into the environment at run time.
SecretVariables - Interface in org.ysb33r.gradle.iac.base.tf: Methods for adding and accessing secrets.
SecretVariablesProvider - Interface in org.ysb33r.gradle.iac.base.tf: Can supply secret variables.
setContents(CopySpec) - Method in interface org.ysb33r.gradle.iac.base.tf.tasks.ModulePublisherTaskMethods: The content that should be published.
setInjectVar(String) - Method in interface org.ysb33r.gradle.iac.base.tf.RemoteStateVarProvider: Whether tokens should be bundled in a variable, an environment variable, or not at all (default).
setInjectVar(RemoteStateInjection) - Method in interface org.ysb33r.gradle.iac.base.tf.RemoteStateVarProvider: Whether tokens should be bundled in a variable, an environment variable, or not at all (default).
setPrefixVersionWithV(boolean) - Method in class org.ysb33r.gradle.iac.base.tf.modules.ModuleRepository: Whether version string should be prefixed with a v.
setReplacements(List<String>) - Method in interface org.ysb33r.gradle.iac.base.tf.ResourceFilter: Mark resources to be replaced.
setSourceSetName(String) - Method in interface org.ysb33r.gradle.iac.base.tf.UsesSourceSetName: Sets the source set name.
setTargets(List<String>) - Method in interface org.ysb33r.gradle.iac.base.tf.ResourceFilter: Select specific resources.
setTokens(Map<String, ?>) - Method in interface org.ysb33r.gradle.iac.base.tf.backends.TokenConfiguration: Replace all tokens with a new set.
setVariablesFiles(Provider<List<File>>) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.UsesVariables: Sets the location of the variables file.
setVarName(String) - Method in interface org.ysb33r.gradle.iac.base.tf.RemoteStateVarProvider: Name of the variable.
SourceSetExecutionEnvironment - Interface in org.ysb33r.gradle.iac.base.tf: Provide thew default executable, environment and secrets associated with a source set.
SourceSetSources - Interface in org.ysb33r.gradle.iac.base.tf: Source set directories and file collections.

T

TaskSetResolver - Class in org.ysb33r.gradle.iac.base.internal.tf: Resolves task classes
TaskSetResolver(Project) - Constructor for class org.ysb33r.gradle.iac.base.internal.tf.TaskSetResolver
template(IacBackendAttributesSpec) - Method in interface org.ysb33r.gradle.iac.base.tf.backends.IacBackendTextTemplate: Returns a template based upon backend attributes.
TfConfig - Interface in org.ysb33r.gradle.iac.base.tf: Global config methods.
token(String, Object) - Method in interface org.ysb33r.gradle.iac.base.tf.backends.TokenConfiguration: Set a single token value.
TokenConfiguration - Interface in org.ysb33r.gradle.iac.base.tf.backends: Configures backend tokens
tokens(Map<String, ?>) - Method in interface org.ysb33r.gradle.iac.base.tf.backends.TokenConfiguration: Adds more tokens.
TokenValue - Interface in org.ysb33r.gradle.iac.base.tf.backends: Describes a token value for a backend.
ToolFeatures - Interface in org.ysb33r.gradle.iac.base.tf: States which features a tool has.

U

useConfiguredPluginCache() - Method in interface org.ysb33r.gradle.iac.base.tf.PluginCacheManagement: Use the plugin cache directory configured in the global configuration of the root project.
useCustomPluginCache() - Method in interface org.ysb33r.gradle.iac.base.tf.PluginCacheManagement: Use a custom plugin cache directory for this source set.
useCustomPluginCache(Object, Integer) - Method in interface org.ysb33r.gradle.iac.base.tf.PluginCacheManagement: Use a custom plugin cache by specifying both a directory and a lock timeout.
UsesSourceSetName - Interface in org.ysb33r.gradle.iac.base.tf: Defines that this task requires a source set name
UsesVariables - Interface in org.ysb33r.gradle.iac.base.tf.config.multilevel: Task interface that indicates the task requires variables.

V

var(String, Object) - Method in interface org.ysb33r.gradle.iac.base.tf.config.multilevel.VariablesSpec: Adds one variable.
VariablesSpec - Interface in org.ysb33r.gradle.iac.base.tf.config.multilevel: Describes variables for Terraform and OpenTofu.

A B E F G I L M N O P R S T U V
All Classes All Packages