StartParameter

open class StartParameter : LoggingConfiguration, ParallelismConfiguration, Serializable(source)

StartParameter defines the configuration used by a Gradle instance to execute a build. The properties of StartParameter generally correspond to the command-line options of Gradle.

You can obtain an instance of a StartParameter by either creating a new one, or duplicating an existing one using newInstance or newBuild.

Constructors

StartParameter

constructor()

Creates a StartParameter with default values.

Properties

buildFile

@get:Nullable

open var buildFile: File

currentDir

open var currentDir: File

DEFAULT_GRADLE_USER_HOME

val DEFAULT_GRADLE_USER_HOME: File

The default user home directory.

excludedTaskNames

open val excludedTaskNames: Set<String>

GRADLE_USER_HOME_PROPERTY_KEY

val GRADLE_USER_HOME_PROPERTY_KEY: String = "gradle.user.home"

gradleUserHomeDir

open var gradleUserHomeDir: File

includedBuilds

open var includedBuilds: List<File>

initScripts

open var initScripts: List<File>

lockedDependenciesToUpdate

open var lockedDependenciesToUpdate: List<String>

projectCacheDir

@get:Nullable

open var projectCacheDir: File

projectDir

@get:Nullable

open var projectDir: File

projectProperties

open var projectProperties: Map<String, String>

settingsFile

@get:Nullable

open var settingsFile: File

systemPropertiesArgs

open var systemPropertiesArgs: Map<String, String>

taskRequests

open val taskRequests: List<TaskExecutionRequest>

welcomeMessageConfiguration

@get:Incubating

@set:Incubating

open var welcomeMessageConfiguration: WelcomeMessageConfiguration

writeDependencyVerifications

open var writeDependencyVerifications: List<String>

Functions

addInitScript

open fun addInitScript(initScriptFile: File)

Adds the given file to the list of init scripts that are run before the build starts.

equals

open fun equals(obj: Any): Boolean

getAllInitScripts

open fun getAllInitScripts(): List<File>

Returns all init scripts, including explicit init scripts and implicit init scripts.

getConsoleOutput

open fun getConsoleOutput(): ConsoleOutput

getDependencyVerificationMode

open fun getDependencyVerificationMode(): DependencyVerificationMode

Returns the dependency verification mode.

getLogLevel

open fun getLogLevel(): LogLevel

getMaxWorkerCount

open fun getMaxWorkerCount(): Int

getShowStacktrace

open fun getShowStacktrace(): ShowStacktrace

getTaskNames

open fun getTaskNames(): List<String>

Returns the names of the tasks to execute in this build.

getWarningMode

open fun getWarningMode(): WarningMode

hashCode

open fun hashCode(): Int

includeBuild

open fun includeBuild(includedBuild: File)

isBuildCacheDebugLogging

open fun isBuildCacheDebugLogging(): Boolean

Whether build cache debug logging is enabled.

isBuildCacheEnabled

open fun isBuildCacheEnabled(): Boolean

Returns true if the build cache is enabled.

isBuildProjectDependencies

open fun isBuildProjectDependencies(): Boolean

Returns true if project dependencies are to be built, false if they should not be.

isBuildScan

open fun isBuildScan(): Boolean

Returns true if build scan should be created.

isConfigurationCacheRequested

@Incubating

open fun ~~isConfigurationCacheRequested~~(): Boolean

Returns true if configuration caching has been requested.

isConfigureOnDemand

@Incubating

open fun isConfigureOnDemand(): Boolean

If the configure-on-demand mode is active

isContinueOnFailure

open fun isContinueOnFailure(): Boolean

Specifies whether the build should continue on task failure.

isContinuous

open fun isContinuous(): Boolean

isDryRun

open fun isDryRun(): Boolean

Is the build running as a dry-run?

isExportKeys

open fun isExportKeys(): Boolean

If true, after writing the dependency verification file, a public keyring file will be generated with all keys seen during generation of the file.

isNoBuildScan

open fun isNoBuildScan(): Boolean

Returns true when build scan creation is explicitly disabled.

isOffline

open fun isOffline(): Boolean

Specifies whether the build should be performed offline (ie without network access).

isParallelProjectExecutionEnabled

open fun isParallelProjectExecutionEnabled(): Boolean

isProfile

open fun isProfile(): Boolean

Returns true if a profile report will be generated.

isRefreshDependencies

open fun isRefreshDependencies(): Boolean

Specifies whether the dependencies should be refreshed..

isRefreshKeys

open fun isRefreshKeys(): Boolean

If true, Gradle will try to download missing keys again.

isRerunTasks

open fun isRerunTasks(): Boolean

Specifies whether the cached task results should be ignored and each task should be forced to be executed.

isWriteDependencyLocks

open fun isWriteDependencyLocks(): Boolean

Returns true when dependency resolution is to be persisted for locking

newBuild

open fun newBuild(): StartParameter

Creates the parameters for a new build, using these parameters as a template.

newInstance

open fun newInstance(): StartParameter

Duplicates this StartParameter instance.

setBuildCacheDebugLogging

open fun setBuildCacheDebugLogging(buildCacheDebugLogging: Boolean)

Whether build cache debug logging is enabled.

setBuildCacheEnabled

open fun setBuildCacheEnabled(buildCacheEnabled: Boolean)

Enables/disables the build cache.

setBuildProjectDependencies

open fun setBuildProjectDependencies(build: Boolean): StartParameter

Specifies whether project dependencies should be built.

setBuildScan

open fun setBuildScan(buildScan: Boolean)

Specifies whether a build scan should be created.

setConfigureOnDemand

@Incubating

open fun setConfigureOnDemand(configureOnDemand: Boolean)

setConsoleOutput

open fun setConsoleOutput(consoleOutput: ConsoleOutput)

setContinueOnFailure

open fun setContinueOnFailure(continueOnFailure: Boolean)

Specifies whether the build should continue on task failure.

setContinuous

open fun setContinuous(enabled: Boolean)

setDependencyVerificationMode

open fun setDependencyVerificationMode(verificationMode: DependencyVerificationMode)

Sets the dependency verification mode.

setDryRun

open fun setDryRun(dryRun: Boolean)

Enables or disables dry-run.

setExcludedTaskNames

open fun setExcludedTaskNames(excludedTaskNames: Iterable<String>)

Sets the tasks to exclude from this build.

setExportKeys

open fun setExportKeys(exportKeys: Boolean)

If true, after writing the dependency verification file, a public keyring file will be generated with all keys seen during generation of the file.

setLogLevel

open fun setLogLevel(logLevel: LogLevel)

setMaxWorkerCount

open fun setMaxWorkerCount(maxWorkerCount: Int)

setNoBuildScan

open fun setNoBuildScan(noBuildScan: Boolean)

Specifies whether build scan creation is explicitly disabled.

setOffline

open fun setOffline(offline: Boolean)

Specifies whether the build should be performed offline (ie without network access).

setParallelProjectExecutionEnabled

open fun setParallelProjectExecutionEnabled(parallelProjectExecution: Boolean)

setProfile

open fun setProfile(profile: Boolean)

Specifies if a profile report should be generated.

setRefreshDependencies

open fun setRefreshDependencies(refreshDependencies: Boolean)

Specifies whether the dependencies should be refreshed..

setRefreshKeys

open fun setRefreshKeys(refresh: Boolean)

Sets the key refresh flag.

setRerunTasks

open fun setRerunTasks(rerunTasks: Boolean)

Specifies whether the cached task results should be ignored and each task should be forced to be executed.

setShowStacktrace

open fun setShowStacktrace(showStacktrace: ShowStacktrace)

setTaskNames

open fun setTaskNames(@Nullable taskNames: Iterable<String>)

Sets the tasks to execute in this build.

setTaskRequests

open fun setTaskRequests(taskParameters: Iterable<out TaskExecutionRequest>)

Sets the task parameters to execute in this build.

setWarningMode

open fun setWarningMode(warningMode: WarningMode)

setWriteDependencyLocks

open fun setWriteDependencyLocks(writeDependencyLocks: Boolean)

Specifies whether dependency resolution needs to be persisted for locking

toString

open fun toString(): String