Pkldoc > schema.kdeps.com/core > org.kdeps.pkl.Project

Settings0.2.17

Properties
Methods

class Settings

Class representing the settings and configurations for a project.

Known subtypes:
Known usages:
All versions:

Properties

link
APIServerMode: Boolean Source

Boolean flag to enable or disable API server mode for the project.
- true: The project runs in API server mode.
- false: The project does not run in API server mode. Default is false.
link

APIServer: APIServerSettings?Source

Settings for configuring the API server, which is optional.

If API server mode is enabled, these settings provide additional configuration for the API server. APIServer.APIServerSettings: Defines the structure and properties for API server settings.
link
WebServerMode: Boolean Source

Boolean flag to enable or disable Web server mode for the project.
- true: The project runs in Web server mode.
- false: The project does not run in Web server mode. Default is false.
link

WebServer: WebServerSettings?Source

Settings for configuring the Web server, which is optional.

If Web server mode is enabled, these settings provide additional configuration for the Web server. WebServer.WebServerConfig: Defines the structure and properties for Web server settings.
link

agentSettings: DockerSettings Source

Docker-related settings for the project's agent.

These settings define how the Docker agent should be configured for the project. Docker.DockerSettings: Includes properties such as Docker image, container settings, and other Docker-specific configurations.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.