TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.projectFeatures/GHEConnection

GHEConnection

open class GHEConnection : ProjectFeature

fun ProjectFeatures.gheConnection(init: GHEConnection.() -> Unit): GHEConnection

Project feature defining an OAuth connection settings for GitHub Enterprise server

Example. It is not recommended to store secure values such as the secret directly in the DSL code, see Managing Tokens section of our documentation.

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        gheConnection {
          id = "<Connection id>" // arbitrary ID that can be later used to refer to the connection
          displayName = "<Connection display name>"
          serverUrl = "<GitHub Enterprise server URL>"
          clientId = "<OAuth2 application client ID>"
          clientSecret = "credentialsJSON:*****"
          useUniqueCallback = true // optional, false by default
        }
Content copied to clipboard
    }
}

Constructors

GHEConnection

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

constructor()

Properties

clientId

var clientId: String?

OAuth connection client id

clientSecret

var clientSecret: String?

OAuth connection client secret

displayName

var displayName: String?

Human friendly connection name

var id: String?

Project feature id, if not specified will be generated

params

val params: List<Parameter>

serverUrl

var serverUrl: String?

URL to GitHub Enterprise server

type

var type: String

Project feature type

useUniqueCallback

var useUniqueCallback: Boolean?

If true, TeamCity adds a unique value to the callback URL, preventing your access token from being intercepted during a mix-up attack. The final callback URL is displayed inside a corresponding section of connection settings in TeamCity admin UI. The default value is false.

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

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

Copies parameters of this object to the specified target

create

open fun create(): ProjectFeature

Creates an instance of this project feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter