package kubecaml

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

Delete_options may be provided when deleting an Api object.

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?propagation_policy:string -> ?preconditions: Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Preconditions.t -> ?orphan_dependents:bool -> ?kind:string -> ?grace_period_seconds:int -> ?api_version:string -> unit -> t
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 grace_period_seconds : t -> int option

The duration in seconds before the object should be deleted. Value must be non_negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

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 orphan_dependents : t -> bool option

Deprecated: please use the Propagation_policy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or Propagation_policy may be set, but not both.

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

val propagation_policy : t -> string option

Whether and how garbage collection will be performed. Either this field or Orphan_dependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource_specific default policy. Acceptable values are: 'orphan' - orphan the dependents; 'background' - allow the garbage collector to delete the dependents in the background; 'foreground' - a cascading policy that deletes all dependents in the foreground.

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