Pkldoc > schema.kdeps.com/core

org.kdeps.pkl.APIServerRequest0.2.17

Overview
Properties
Methods
Classes

open module org.kdeps.pkl.APIServerRequest

Abstractions for Kdeps API Server Requests

Module URI:: package://schema.kdeps.com/core@0.2.17#/deps/pkl/APIServerRequest.pkl
Pkl version:: 0.28.1 or higher
Source code:: APIServerRequest.pkl
Known subtypes:
Known usages:
All versions:

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

hidden

apiMethodRegex: unknownSource

Regex for allowed HTTP Methods.

Matches HTTP methods in a case-insensitive manner. Allowed methods are: GET, POST, PUT, PATCH, OPTIONS, DELETE, and HEAD.
link

hidden

isValidHTTPMethod: unknownSource

Validates if the provided HTTP method str is supported.

Returns true if the method is valid; otherwise, throws an error with a descriptive message.

Example usage:

isValidHTTPMethod("POST") // true isValidHTTPMethod("INVALID") // Error: Invalid HTTP method.

str: The HTTP method string to validate. bool: True if the HTTP method is valid, otherwise throws an error.
link

path: Uri Source

Represents the request URI path.
link

IP: String Source

Represents the Client IP.
link

ID: String Source

Represents the Request ID.
link

method: String(isValidHTTPMethod)Source

The HTTP method used for the request. Must be a valid method, as determined by isValidHTTPMethod.
link

data: String?Source

The body data of the request, which is optional.
link

params: Mapping<String, String>?Source

Query parameters sent with the request.
link

headers: Mapping<String, String>?Source

Headers sent with the request.
link

files: Mapping<String, APIServerRequestUploads>?Source

Files uploaded with the request, represented as a mapping of file keys to upload metadata.
link

hidden

fileKeys: unknownSource

Retrieves the keys of the uploaded files.
link

hidden

firstFileKey: unknownSource

Retrieves the first key of the uploaded files or null if no files are uploaded.

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)
```
link

function

data(): String Source

Retrieves the Base64-decoded body data of the request.

Returns an empty string if no body data is provided or if the data is already decoded.

str: The Base64-decoded request body.
link

function

params(name: String): String Source

Retrieves the decoded value of the query parameter name.

Returns an empty string if the parameter does not exist.

name: The query parameter to retrieve. str: The Base64-decoded value of the query parameter.
link

function

header(name: String): String Source

Retrieves the decoded value of the header name.

Returns an empty string if the header does not exist.

name: The header name to retrieve. str: The Base64-decoded value of the header.
link

function

file(name: String): APIServerRequestUploads Source

Retrieves metadata for the uploaded file with the key name.

If the file with the specified key does not exist, returns metadata for the first available file, or returns an empty file metadata object if no files are uploaded.

name: The key of the file to retrieve. APIServerRequestUploads: The metadata for the requested file.
link

function

filetype(name: String): String Source

Retrieves the MIME type of the uploaded file with the key name.

name: The key of the file to retrieve the MIME type for. str: The MIME type of the file.
link

function

filepath(name: String): String Source

Retrieves the file path of the uploaded file with the key name.

name: The key of the file to retrieve the file path for. str: The file path of the file.
link

function

filecount(): String Source

Returns the total number of uploaded files.

str: The number of uploaded files as a string.
link

function

files(): Listing Source

Retrieves a list of file paths for all uploaded files.

Listing: A list of file paths for uploaded files.
link

function

filetypes(): Listing Source

Retrieves a list of MIME types for all uploaded files.

Listing: A list of MIME types for uploaded files.
link

function

filesByType(mimeType: String): Listing Source

Retrieves a list of file paths for uploaded files that match the given MIME type mimeType.

mimeType: The MIME type to filter files by. Listing: A list of file paths for files that match the specified MIME type.
link

function

path(): String Source

Retrieves the URI path of the request.

str: The URI path of the request.
link

function

method(): String Source

Retrieves the HTTP method of the request.

str: The HTTP method of the request.
link

function

IP(): String Source

Retrieves the Client IP of the request.

str: The Client IP of the request.
link

function

ID(): String Source

Retrieves the Request ID of the request.

str: The Request ID of the request.

Classes

link

class

APIServerRequestUploads Source

Represents metadata for an uploaded file, including its file path and MIME type.

org.kdeps.pkl.APIServerRequest0.2.17

Properties(show inherited)

Example usage:

Methods(show inherited)

Classes