Property Detail

• java.lang.Object destinationDir

• java.lang.Object templateFile

• java.lang.Object textTemplate

Constructor Detail

• RemoteStateConfigGenerator()

Method Detail

• void addTokenProvider(Provider<java.util.Map<java.lang.String, java.lang.Object>> tokenProvider)

  Adds a provider of tokens. These providers are processed before any of the customisations on the backend provider.

  Parameters:

  tokenProvider - Addition provider of tokens

  Since:

  1.0

• @TaskAction void exec()

• @OutputFile Provider<java.io.File> getBackendConfigFile()

  The location of the backend configuration file.

  Returns:

  Configuration file.

• @Internal boolean getBackendFileRequired()

  Returns whether a backend partial configuration file should be generated.

  Returns:

  true is one is required.

• @Input Provider<java.lang.String> getBeginTokenProvider()

  Starting delimiter for tokens. Only useful when a custom template is used.

  Returns:

  Delimiter

  Since:

  0.12

• @Internal java.lang.String getDefaultTextTemplate()

  The default text template that will be used if nothing else is configured.

  Returns:

  Default template or empty string if not backend is associated with the task.

• @Internal Provider<java.io.File> getDestinationDir()

  The output directory for the configuration file

  Returns:

• @Input Provider<java.lang.String> getEndTokenProvider()

  Terminating delimiter for tokens Only useful when a custom template is used.

  Returns:

  Delimiter

  Since:

  0.12

• @java.util.Optional @InputFile Provider<java.io.File> getTemplateFile()

  Returns location of template file.

  Returns:

  Location of template file if set.

• @Internal Provider<BackendTextTemplate> getTextTemplate()

  Returns text template.

  Returns:

  text of template if set.

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

  Returns the current set of tokens

  Returns:

  Tokens used for replacements.

• void setDestinationDir(java.lang.Object dir)

  Override the output directory.

  Parameters:

  dir - Anything convertible to a file path.

• void setRemoteState(TerraformRemoteStateExtension source)

  Set remote state. This removes any previous settings of setTextTemplate and setTemplateFile.

  Parameters:

  source - Remote state extension associated with this configuration generator.

• void setTemplateFile(java.lang.Object file)

  Applies a custom template file for backend configuration. The default is to use the template file from the remote extension on the source set.

  Parameters:

  file - Location of template file

• void setTextTemplate(java.lang.Object text)

  Use a string as a template. The default is to use the template text from the remote extension on the source set.

  Parameters:

  text - Template that can be processed by Ant's ReplaceTokens.

  Since:

  0.11