package kubecaml

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

Object_reference contains enough information to let you inspect or modify the referred object.

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?uid:string -> ?resource_version:string -> ?namespace:string -> ?name:string -> ?kind:string -> ?field_path:string -> ?api_version:string -> unit -> t
val api_version : t -> string option

Api version of the referent.

val field_path : t -> string option

If referring to a piece of an object instead of an entire object, this string should contain a valid Json/go field access statement, such as desired_state.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well_defined way of referencing a part of an object.

val kind : t -> string option

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

val name : t -> string option

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

val namespace : t -> string option

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

val resource_version : t -> string option

Specific resource_version to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

val uid : t -> string option

Uid of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

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