All Implemented Interfaces:

io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmInstallFromRepositoryOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmInstallationOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmServerOperationOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmServerOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmValueOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmInstallFromRepositoryOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmInstallationOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmServerOperationOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmServerOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmValueOptions , io.github.build.extensions.oss.gradle.plugins.helm.release.dsl.HelmReleaseProperties , org.gradle.api.Named
```
public interface HelmRelease
 implements Named, HelmReleaseProperties, ConfigurableHelmInstallFromRepositoryOptions
                    
```
Represents a release to be installed into or uninstalled from a Kubernetes cluster.
Provides methods for target-specific configuration of the release.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`HelmRelease.TargetSpecific`	Used to configure a HelmRelease for a specific release target.

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
`Unit`	`tags(Iterable<String> tags)`	Declare tags for this release.
`Unit`	`tags(String tags)`	Declare tags for this release.
`abstract Unit`	`valuesDirs(Iterable<Object> directories)`	Adds directories containing values files to the release.
`Unit`	`valuesDirs(Object directories)`	Adds directories containing values files to the release.
`Unit`	`valuesDir(Object directory)`	Adds a directory containing values files to the release.
`abstract Unit`	`forTargets(Iterable<String> targets, Action<HelmRelease.TargetSpecific> action)`	Adds a target-specific configuration action for the given release targets.
`Unit`	`forTargets(String targets, Action<HelmRelease.TargetSpecific> action)`	Adds a target-specific configuration action for the given release targets.
`Unit`	`forTarget(String target, Action<HelmRelease.TargetSpecific> action)`	Adds a target-specific configuration action for the given release target.
`Unit`	`forAnyTarget(Action<HelmRelease.TargetSpecific> action)`	Adds a target-specific configuration action for any target.
`abstract Set<String>`	`getTags()`
`abstract ListProperty<File>`	`getValuesDirs()`
`abstract Property<String>`	`getReleaseName()`
`abstract Property<ChartReference>`	`getChart()`
`abstract Property<Boolean>`	`getReplace()`
`abstract Property<Integer>`	`getHistoryMax()`
`abstract Property<Boolean>`	`getKeepHistoryOnUninstall()`
`abstract SetProperty<String>`	`getDependsOn()`
`abstract Set<Object>`	`getInstallDependsOn()`
`abstract Set<String>`	`getMustInstallAfter()`
`abstract Set<String>`	`getMustUninstallAfter()`
`abstract ConfigurableHelmReleaseTestOptions`	`getTest()`
`abstract Property<URI>`	`getRepository()`
`abstract Property<String>`	`getUsername()`
`abstract Property<String>`	`getPassword()`
`abstract RegularFileProperty`	`getCaFile()`
`abstract RegularFileProperty`	`getCertFile()`
`abstract RegularFileProperty`	`getKeyFile()`
`abstract MapProperty<String, Object>`	`getValues()`
`abstract MapProperty<String, Object>`	`getFileValues()`
`abstract ConfigurableFileCollection`	`getValueFiles()`

Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.release.dsl.HelmReleaseProperties
chart, chart, chart, dependsOn, dependsOn, from, installDependsOn, installDependsOn, mustInstallAfter, mustUninstallAfter, test
Methods inherited from class org.gradle.api.Named
getName
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - tags
```
 Unit tags(Iterable<String> tags)
```
    Declare tags for this release.
    Tags can be used to filter the set of releases to be installed or uninstalled. Releases that do not have any tags will always be installed.
    
    Parameters:
    
    tags - the tags to use for this release
  - tags
```
 Unit tags(String tags)
```
    Declare tags for this release.
    Tags can be used to filter the set of releases to be installed or uninstalled. Releases that do not have any tags will always be installed.
    
    Parameters:
    
    tags - the tags to use for this release
  - valuesDirs
```
 abstract Unit valuesDirs(Iterable<Object> directories)
```
    Adds directories containing values files to the release.
    
    Parameters:
    
    directories - the directories to add.
  - valuesDirs
```
 Unit valuesDirs(Object directories)
```
    Adds directories containing values files to the release.
    
    Parameters:
    
    directories - the directories to add.
  - valuesDir
```
 Unit valuesDir(Object directory)
```
    Adds a directory containing values files to the release.
    
    Parameters:
    
    directory - the directory to add.
  - forTargets
```
 abstract Unit forTargets(Iterable<String> targets, Action<HelmRelease.TargetSpecific> action)
```
    Adds a target-specific configuration action for the given release targets.
    Target names can be prefixed with an exclamation mark (e.g. !target) to apply the configuration for any but the given target.
    
    Parameters:
    
    targets - the names of release targets
    
    action - the target-specific configuration to apply
  - forTargets
```
 Unit forTargets(String targets, Action<HelmRelease.TargetSpecific> action)
```
    Adds a target-specific configuration action for the given release targets.
    Target names can be prefixed with an exclamation mark (e.g. !target) to apply the configuration for any but the given target.
    
    Parameters:
    
    targets - the names of release targets
    
    action - the target-specific configuration to apply
  - forTarget
```
 Unit forTarget(String target, Action<HelmRelease.TargetSpecific> action)
```
    Adds a target-specific configuration action for the given release target.
    The target name can be prefixed with an exclamation mark (e.g. !target) to apply the configuration for any but the given target.
    
    Parameters:
    
    target - the name of the release target
    
    action - the target-specific configuration to apply
  - forAnyTarget
```
 Unit forAnyTarget(Action<HelmRelease.TargetSpecific> action)
```
    Adds a target-specific configuration action for any target.
    Use this method to specify a custom configuration block that depends on the HelmReleaseTarget, which is available via the TargetSpecific.target property in the action parameter.
    
    Parameters:
    
    action - the target-specific configuration to apply
  - getTags
```
 abstract Set<String> getTags()
```
  - getValuesDirs
```
 abstract ListProperty<File> getValuesDirs()
```
  - getReleaseName
```
 abstract Property<String> getReleaseName()
```
  - getChart
```
 abstract Property<ChartReference> getChart()
```
  - getReplace
```
 abstract Property<Boolean> getReplace()
```
  - getHistoryMax
```
 abstract Property<Integer> getHistoryMax()
```
  - getKeepHistoryOnUninstall
```
 abstract Property<Boolean> getKeepHistoryOnUninstall()
```
  - getDependsOn
```
 abstract SetProperty<String> getDependsOn()
```
  - getInstallDependsOn
```
 abstract Set<Object> getInstallDependsOn()
```
  - getMustInstallAfter
```
 abstract Set<String> getMustInstallAfter()
```
  - getMustUninstallAfter
```
 abstract Set<String> getMustUninstallAfter()
```
  - getTest
```
 abstract ConfigurableHelmReleaseTestOptions getTest()
```
  - getRepository
```
 abstract Property<URI> getRepository()
```
  - getUsername
```
 abstract Property<String> getUsername()
```
  - getPassword
```
 abstract Property<String> getPassword()
```
  - getCaFile
```
 abstract RegularFileProperty getCaFile()
```
  - getCertFile
```
 abstract RegularFileProperty getCertFile()
```
  - getKeyFile
```
 abstract RegularFileProperty getKeyFile()
```
  - getValues
```
 abstract MapProperty<String, Object> getValues()
```
  - getFileValues
```
 abstract MapProperty<String, Object> getFileValues()
```
  - getValueFiles
```
 abstract ConfigurableFileCollection getValueFiles()
```

Interface HelmRelease

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.release.dsl.HelmReleaseProperties

Methods inherited from class org.gradle.api.Named

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

tags

tags

valuesDirs

valuesDirs

valuesDir

forTargets

forTargets

forTarget

forAnyTarget

getTags

getValuesDirs

getReleaseName

getChart

getReplace

getHistoryMax

getKeepHistoryOnUninstall

getDependsOn

getInstallDependsOn

getMustInstallAfter

getMustUninstallAfter

getTest

getRepository

getUsername

getPassword

getCaFile

getCertFile

getKeyFile

getValues

getFileValues

getValueFiles