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:*****"
}





}
}




See also

Constructors

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

Properties

Link copied to clipboard
var clientId: <Error class: unknown class>

OAuth connection client id

Link copied to clipboard
var clientSecret: <Error class: unknown class>

OAuth connection client secret

Link copied to clipboard
var displayName: <Error class: unknown class>

Human friendly connection name

Link copied to clipboard
var id: String?

Project feature id, if not specified will be generated

Link copied to clipboard
Link copied to clipboard
var serverUrl: <Error class: unknown class>

URL to GitHub Enterprise server

Link copied to clipboard

Project feature type

Functions

Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, 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

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.

Link copied to clipboard
fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
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): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
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 fun stringParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer