HashiCorpVaultParameter

HashiCorp vault remote parameter

Example. Adds a new vault parameter with the name test that will fetch a value from the KV 1.0 vault named secret from the path path/to, with the key key. The connection namespace to use it is connection-1

hashiCorpVaultParameter {
name = "test"
query = "secret/path/to!/key"
vaultId = "connection-1"
}

Example. Adds a new vault parameter with the name test that will fetch a value from the KV 2.0 vault named secret from the path path/to, with the key key. The connection namespace to use it is connection-1

hashiCorpVaultParameter {
name = "test"
query = "secret/data/path/to!/key"
vaultId = "connection-1"
}

See also

Constructors

Link copied to clipboard
constructor(init: HashiCorpVaultParameter.() -> Unit)
constructor()

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The vault connection namespace id that should be used to access this secret

Link copied to clipboard
Link copied to clipboard

The query to access the KV vault. It should be written in the vaultName/path/to!/key format. Should your vault be a KV 2.0, the query should be in the vaultName/data/path/to!/key format.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The vault connection id that should be used to access this secret

Functions

Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
fun doubleParameter(customName: String? = null): DelegateProvider<Double>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): DelegateProvider<E>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): DelegateProvider<Int>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open override fun stringParameter(customName: String?): DelegateProvider<String>
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer