Pkldoc > schema.kdeps.com/core

org.kdeps.pkl.APIServerResponse0.2.18

Overview
Properties
Methods
Classes

open module org.kdeps.pkl.APIServerResponse

Abstractions for Kdeps API Server Responses

Module URI:: package://schema.kdeps.com/core@0.2.18#/deps/pkl/APIServerResponse.pkl
Source code:: APIServerResponse.pkl
Known subtypes:
Known usages:
All versions:: 0.2.18

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link
success: Boolean Source

A Boolean flag indicating whether the API request was successful.
- true: The request was successful.
- false: The request encountered an error.
link

meta: APIServerResponseMetaBlock?Source

Additional metadata related to the API request.

Provides request-specific details such as headers, properties, and tracking information.
link

response: APIServerResponseBlock?Source

The response block containing data returned by the API server in a successful request, if any.

If the request was successful, this block contains the data associated with the response. APIServerResponseBlock: Contains a listing of the returned data items.
link

errors: Listing<APIServerErrorsBlock>?Source

The error block containing details of any error encountered during the API request.

If the request was unsuccessful, this block contains the error code and error message returned by the server. APIServerErrorsBlock: Contains the error code and message explaining the issue.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

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

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

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

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

function

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

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

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```

Classes

link

class

APIServerResponseBlock Source

Class representing a block of data returned in a successful API response.
link

class

APIServerResponseMetaBlock Source

Contains metadata related to an API response.
link

class

APIServerErrorsBlock Source

Class representing error details returned in an API response when an error occurs.