Interface Filtering

  • All Implemented Interfaces:

    
    public interface Filtering
    
                        

    Configures filtering of chart sources.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class Filtering.Companion
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Property<Boolean> getEnabled() Indicates if filtering is enabled.
      abstract MapProperty<String, Object> getValues() Values to be inserted for placeholders.
      abstract MapProperty<String, Object> getFileValues() Values to be inserted for placeholders, read from the contents of files.
      abstract ListProperty<String> getFilePatterns() Patterns of file names to be filtered.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getEnabled

        @Input() abstract Property<Boolean> getEnabled()

        Indicates if filtering is enabled. The default is true.

      • getValues

        @Input() abstract MapProperty<String, Object> getValues()

        Values to be inserted for placeholders.

      • getFileValues

        @Internal() abstract MapProperty<String, Object> getFileValues()

        Values to be inserted for placeholders, read from the contents of files.

        The values of the map can be of any type that is accepted by Project.file. Values of type org.gradle.api.file.FileCollection are also allowed, provided that they contain only a single file.

        Additionally, when adding a Provider that represents an output file of another task, the corresponding filtering task will automatically have a task dependency on the producing task.

        If the same key is present both in values and fileValues, then the entry from values has precedence.

      • getFilePatterns

        @Input() abstract ListProperty<String> getFilePatterns()

        Patterns of file names to be filtered.

        If this is an empty list, all files in the chart will be subject to filtering.

        By default, this includes Chart.yaml, values.yaml and requirements.yaml but not any of the chart's template files. For the latter, it is recommended to put the filtered values into values.yaml and apply Helm's templating mechanisms in the template files.