package kubecaml

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

Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system.

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?type_:string -> ?series:Kubernetes.Definitions.Api.Events.V1beta1.Event_series.t -> ?reporting_instance:string -> ?reporting_controller:string -> ?related:Kubernetes.Definitions.Api.Core.V1.Object_reference.t -> ?regarding:Kubernetes.Definitions.Api.Core.V1.Object_reference.t -> ?reason:string -> ?note:string -> ?metadata:Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Object_meta.t -> ?kind:string -> event_time:Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Micro_time.t -> ?deprecated_source:Kubernetes.Definitions.Api.Core.V1.Event_source.t -> ?deprecated_last_timestamp: Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Time.t -> ?deprecated_first_timestamp: Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Time.t -> ?deprecated_count:int -> ?api_version:string -> ?action:string -> unit -> t
val action : t -> string option

What action was taken/failed regarding to the regarding object.

val api_version : t -> string option

Api_version defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

val deprecated_count : t -> int option

Deprecated field assuring backward compatibility with core.v1 Event type

val deprecated_first_timestamp : t -> Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Time.t option

Deprecated field assuring backward compatibility with core.v1 Event type

val deprecated_last_timestamp : t -> Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Time.t option

Deprecated field assuring backward compatibility with core.v1 Event type

val deprecated_source : t -> Kubernetes.Definitions.Api.Core.V1.Event_source.t option

Deprecated field assuring backward compatibility with core.v1 Event type

Required. Time when this Event was first observed.

val kind : t -> string option

Kind is a string value representing the Rest resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In Camel_case. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

val note : t -> string option

Optional. A human_readable description of the status of this operation. Maximal length of the note is 1k_b, but libraries should be prepared to handle values up to 64k_b.

val reason : t -> string option

Why the action was taken.

The object this Event is about. In most cases it's an Object reporting controller implements. E.g. Replica_set_controller implements Replica_sets and this event is emitted because it acts on some changes in a Replica_set object.

Optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.

val reporting_controller : t -> string option

Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.

val reporting_instance : t -> string option

Id of the controller instance, e.g. `kubelet_xyzf`.

Data about the Event series this event represents or nil if it's a singleton Event.

val type_ : t -> string option

Type of this event (normal, Warning), new types could be added in the future.

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 OCaml Planet 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