TerraformRemoteStateExtension (Jobble Gradle Plugin Suite Combined API 0.13.1)

org.ysb33r.gradle.terraform.remotestate.TerraformRemoteStateExtension

All Implemented Interfaces and Traits:

BackendAttributesSpec
```
@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
class TerraformRemoteStateExtension
```
Extension that is added to the project TerraformExtension and to instances of TerraformSourceDirectorySet
Authors:
Schalk W. Cronjé
Since:
0.8.0

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`NAME`

Properties Summary

Properties
Type	Name and description
`java.lang.Object`	`prefix`

Constructor Summary

Constructors
Constructor and description
`TerraformRemoteStateExtension (Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`backend(java.lang.String backendType, Action<? extends BackendSpec> configurator)` Replaces the existing backend with another registered one and configures it.
	`void`	`backend(java.lang.Class<? extends BackendSpec> backendType, Action<? extends BackendSpec> configurator)` Replaces the existing backend with another registered one and configures it.
`<T extends BackendSpec>`	`static T`	`findBackend(Project project, java.lang.Class<T> backend)` A utility to find the global configuration for a specific backend
	`static TerraformRemoteStateExtension`	`findExtension(Project project)` A utility to locate the extension.
	`static TerraformRemoteStateExtension`	`findExtension(Project project, java.lang.String sourceSetName)` Utility to find this extension on a terraform source set.
	`void`	`follow(TerraformRemoteStateExtension other)` Follows the settings of another remote state extension.
	`java.lang.String`	`getBackendName()` The name of the currently configured backend.
	`Provider<BackendSpec>`	`getBackendProvider()` A provider to the configured backend.
	`Provider<java.lang.String>`	`getBeginTokenProvider()` Starting delimiter for tokens.
	`java.lang.String`	`getDefaultTextTemplate()` The default template used for the partial configuration of the backend.
	`Provider<java.lang.String>`	`getEndTokenProvider()` Terminating delimiter for tokens
	`Provider<java.lang.String>`	`getPrefix()` A prefix that is added to remote state names.
	`Provider<java.lang.Boolean>`	`getRemoteStateVarProvider()` A provider to indicate whether remote state tokens should be added as a terraform map variable.
	`Provider<java.io.File>`	`getTemplateFile()` Returns location of template file.
	`Provider<BackendTextTemplate>`	`getTextTemplate()` Returns text template.
	`Provider<java.util.Map<java.lang.String, ?>>`	`getTokenProvider()` A provider of all of the tokens that were configured in the active backend.
	`java.util.Map<java.lang.String, java.lang.Object>`	`getTokens()` Returns the current set of tokens
	`void`	`noFollow()` Do not follow any other remote state.
	`void`	`setBackend(java.lang.String backendType)` Replaces the existing backend with another registered one.
	`void`	`setBackend(java.lang.Class<? extends BackendSpec> backendType)` Replaces the existing backend with another registered one.
	`void`	`setPrefix(java.lang.Object p)` Assign the prefix.
	`void`	`setRemoteStateVar(boolean asVar)` Whether tokens should be bundled in a map variable called `remote_state`.

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

- Field Detail
  - public static final java.lang.String NAME
- Property Detail
  - java.lang.Object prefix
- Constructor Detail
  - TerraformRemoteStateExtension(Project project)
- Method Detail
  - void backend(java.lang.String backendType, Action<? extends BackendSpec> configurator)
    
    Replaces the existing backend with another registered one and configures it.
    Parameters:
    backendType - Name of backend
    configurator - Configurator
    Throws:
    TerraformUnknownBackendException if backend not registered.
    Since:
    0.12
  - void backend(java.lang.Class<? extends BackendSpec> backendType, Action<? extends BackendSpec> configurator)
    
    Replaces the existing backend with another registered one and configures it.
    Parameters:
    backendType - Type of backend
    configurator - Configurator
    Throws:
    TerraformUnknownBackendException if backend not registered.
    Since:
    0.12
  - <T extends BackendSpec> static T findBackend(Project project, java.lang.Class<T> backend)
    
    A utility to find the global configuration for a specific backend
    Parameters:
    project - Project to interrogate
    backend - Backend to find
    Returns:
    GLobal backend configuration
    Throws:
    TerraformUnknownBackendException if backend not registered
    Since:
    0.12
  - static TerraformRemoteStateExtension findExtension(Project project)
    
    A utility to locate the extension.
    Parameters:
    project - Project context
    Returns:
    TerraformRemoteStateExtension if it has been added.
  - static TerraformRemoteStateExtension findExtension(Project project, java.lang.String sourceSetName)
    
    Utility to find this extension on a terraform source set.
    Parameters:
    project - Project context
    sourceSetName - Name of source set.
    Returns:
    Extension after it has been attached.
    Since:
    0.10.0
  - @java.lang.SuppressWarnings('LineLength') void follow(TerraformRemoteStateExtension other)
    
    Follows the settings of another remote state extension. If the other remote has a backend provider configured, set this remote state to be the same. This overrides any previous configured backend. If you want a different backend or fix the usage of a remote state variable map, you'll need to set it after the follow call. Tokens will be read from the followed extension first and then overwritten by and local setting.
    Parameters:
    other - Instance of TerraformRemoteStateExtension to follow.
  - java.lang.String getBackendName()
    
    The name of the currently configured backend.
    Returns:
    Name of backend. Can be null is no backend is configured.
    Since:
    0.12
  - Provider<BackendSpec> getBackendProvider()
    
    A provider to the configured backend.
    Returns:
    Backend provider. Can be empty if no backend has been configured.
    Since:
    0.12
  - @java.lang.Override Provider<java.lang.String> getBeginTokenProvider()
    
    Starting delimiter for tokens.
    Only useful when a custom template is used.
    Returns:
    Provider for start delimiter
    Since:
    0.12
  - @java.lang.Override java.lang.String getDefaultTextTemplate()
    
    The default template used for the partial configuration of the backend.
    Returns:
    Default template as a string.
  - @java.lang.Override Provider<java.lang.String> getEndTokenProvider()
    
    Terminating delimiter for tokens
    Only useful when a custom template is used.
    Returns:
    Provider for end delimiter
    Since:
    0.12
  - Provider<java.lang.String> getPrefix()
    
    A prefix that is added to remote state names.
  - Provider<java.lang.Boolean> getRemoteStateVarProvider()
    
    A provider to indicate whether remote state tokens should be added as a terraform map variable.
    Returns:
    Decision provider.
    Since:
    0.12
  - @java.lang.Override Provider<java.io.File> getTemplateFile()
    
    Returns location of template file.
    Returns:
    Location of template file if set.
  - @java.lang.Override Provider<BackendTextTemplate> getTextTemplate()
    
    Returns text template.
    Returns:
    text of template if set.
  - Provider<java.util.Map<java.lang.String, ?>> getTokenProvider()
    
    A provider of all of the tokens that were configured in the active backend.
    Returns:
    Provider of a map of lazy-evaluated tokens.
    Since:
    0.12
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getTokens()
    
    Returns the current set of tokens
    Returns:
    Tokens used for replacements.
  - void noFollow()
    
    Do not follow any other remote state. This will set the following
    - setPrefix to the snapshot of the previously followed value or an empty string.
    - setRemoteStateVar to the snapshot of the previously followed value or false.
    Since:
    0.12
  - void setBackend(java.lang.String backendType)
    
    Replaces the existing backend with another registered one.
    Parameters:
    backendType - Name of backend.
    Throws:
    TerraformUnknownBackendException if backend not registered.
    Since:
    0.12
  - void setBackend(java.lang.Class<? extends BackendSpec> backendType)
    
    Replaces the existing backend with another registered one.
    Parameters:
    backendType - Type of backend.
    Throws:
    TerraformUnknownBackendException if backend not registered.
    Since:
    0.12
  - void setPrefix(java.lang.Object p)
    
    Assign the prefix.
    Parameters:
    p - Object that can be converted to a string. Can be a Provider as well.
  - void setRemoteStateVar(boolean asVar)
    
    Whether tokens should be bundled in a map variable called remote_state.
    Parameters:
    asVar
    Since:
    0.12

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class TerraformRemoteStateExtension

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String NAME

Property Detail

java.lang.Object prefix

Constructor Detail

TerraformRemoteStateExtension(Project project)

Method Detail

void backend(java.lang.String backendType, Action<? extends BackendSpec> configurator)

void backend(java.lang.Class<? extends BackendSpec> backendType, Action<? extends BackendSpec> configurator)

<T extends BackendSpec> static T findBackend(Project project, java.lang.Class<T> backend)

static TerraformRemoteStateExtension findExtension(Project project)

static TerraformRemoteStateExtension findExtension(Project project, java.lang.String sourceSetName)

@java.lang.SuppressWarnings('LineLength') void follow(TerraformRemoteStateExtension other)

java.lang.String getBackendName()

Provider<BackendSpec> getBackendProvider()

@java.lang.Override Provider<java.lang.String> getBeginTokenProvider()

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

@java.lang.Override Provider<java.lang.String> getEndTokenProvider()

Provider<java.lang.String> getPrefix()

Provider<java.lang.Boolean> getRemoteStateVarProvider()

@java.lang.Override Provider<java.io.File> getTemplateFile()

@java.lang.Override Provider<BackendTextTemplate> getTextTemplate()

Provider<java.util.Map<java.lang.String, ?>> getTokenProvider()

@java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getTokens()

void noFollow()

void setBackend(java.lang.String backendType)

void setBackend(java.lang.Class<? extends BackendSpec> backendType)

void setPrefix(java.lang.Object p)

void setRemoteStateVar(boolean asVar)