package kubecaml

  1. Overview
  2. Docs
package kubecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

Api_resource specifies the name of a resource and whether it is namespaced.

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?version:string -> verbs:string list -> singular_name:string -> ?short_names:string list -> namespaced:bool -> name:string -> kind:string -> ?group:string -> ?categories:string list -> unit -> t
val categories : t -> string list option

categories is a list of the grouped resources this resource belongs to (e.g. 'all')

val group : t -> string option

group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: "scale".

val kind : t -> string

kind is the kind for the resource (e.g. 'foo' is the kind for a resource 'foo')

val name : t -> string

name is the plural name of the resource.

val namespaced : t -> bool

namespaced indicates if a resource is namespaced or not.

val short_names : t -> string list option

short_names is a list of suggested short names of the resource.

val singular_name : t -> string

singular_name is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singular_name is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl Cli interface.

val verbs : t -> string list

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)

val version : t -> string option

version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group).

module Object : Object.S with type value := t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events Blog Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct