TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.remoteParameters/HashiCorpVaultParameter

HashiCorpVaultParameter

open class HashiCorpVaultParameter : RemoteParameter

fun ParametrizedWithType.hashiCorpVaultParameter(init: HashiCorpVaultParameter.() -> Unit): 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"
}

Constructors

HashiCorpVaultParameter

constructor(init: HashiCorpVaultParameter.() -> Unit)

constructor()

Properties

description

var description: String

display

var display: ParameterDisplay

label

var label: String

name

var name: String

namespace

var ~~namespace~~: <Error class: unknown class>

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

params

val params: List<Parameter>

query

var query: <Error class: unknown class>

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.

readOnly

var readOnly: Boolean

type

var type: String

vaultId

var vaultId: <Error class: unknown class>

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

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

doubleParameter

fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

findRawParam