Krill SDK/krill.zone.shared.io/HttpMethod

HttpMethod

enum HttpMethod : Enum<HttpMethod> (source)

The set of HTTP verbs the Krill protocol emits or accepts.

Kept intentionally small: Krill does not need OPTIONS/HEAD on the request side, and responses are modelled separately. Entries map 1:1 onto the corresponding Ktor HTTP method when a request is actually dispatched.

Entries

GET

Read-only retrieval. Used for fetching node state, snapshots, config. No request body.

POST

Create or submit. Used for node creation, triggering executors, uploading blobs. Carries a request body.

PUT

Full replace of a resource. Used when a client replaces an entire node's metadata or configuration. Carries a request body.

DELETE

Destructive removal. Used to delete a node, peer relationship, or persisted artifact. Body optional.

PATCH

Partial update. Used when a client mutates a subset of fields on an existing node without replacing the whole record. Carries a request body.

Properties

entries

val entries: EnumEntries<HttpMethod>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): HttpMethod

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<HttpMethod>

Returns an array containing the constants of this enum type, in the order they're declared.