api / org.gradle.api.logging.configuration / LoggingConfiguration

LoggingConfiguration

interface LoggingConfiguration

A LoggingConfiguration defines the logging settings for a Gradle build.

Functions

getConsoleOutput

abstract fun getConsoleOutput(): ConsoleOutput

Returns the style of logging output that should be written to the console. Defaults to ConsoleOutput#Auto

getLogLevel

abstract fun getLogLevel(): LogLevel

Returns the minimum logging level to use. All log messages with a lower log level are ignored. Defaults to LogLevel#LIFECYCLE.

getShowStacktrace

abstract fun getShowStacktrace(): ShowStacktrace

Returns the detail that should be included in stacktraces. Defaults to ShowStacktrace#INTERNAL_EXCEPTIONS.

getWarningMode

abstract fun getWarningMode(): WarningMode

Specifies which type of warnings should be written to the console.

setConsoleOutput

abstract fun setConsoleOutput(consoleOutput: ConsoleOutput): Unit

Specifies the style of logging output that should be written to the console.

setLogLevel

abstract fun setLogLevel(logLevel: LogLevel): Unit

Specifies the minimum logging level to use. All log messages with a lower log level are ignored.

setShowStacktrace

abstract fun setShowStacktrace(showStacktrace: ShowStacktrace): Unit

Sets the detail that should be included in stacktraces.

setWarningMode

abstract fun setWarningMode(warningMode: WarningMode): Unit

Specifies which type of warnings should be written to the console.

Inheritors

StartParameter

open class StartParameter : LoggingConfiguration, ParallelismConfiguration, Serializable

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.