package kubecaml

  1. Overview
  2. Docs
package kubecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module By_name : sig ... end
val request_path_template : unit -> string
val get : ?pretty:string -> namespace:string -> ?continue:string -> ?field_selector:string -> ?include_uninitialized:bool -> ?label_selector:string -> ?limit:int -> ?resource_version:string -> ?timeout_seconds:int -> ?watch:bool -> ?ctx:Cohttp_lwt_unix.Client.ctx -> ?headers:Cohttp.Header.t -> Uri.t -> (Kubernetes.Definitions.Api.Extensions.V1beta1.Ingress_list.t, string) Stdlib.result Lwt.t

list or watch objects of kind Ingress

  • parameter pretty

    If 'true', then the output is pretty printed.

  • parameter namespace

    object name and auth scope, such as for teams and projects

  • parameter continue

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 Resource_expired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resource_version value returned by the server and not miss any modifications.

  • parameter field_selector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • parameter include_uninitialized

    If true, partially initialized resources are included in the response.

  • parameter label_selector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • parameter limit

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    the server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

  • parameter resource_version

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum_read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

  • parameter timeout_seconds

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

  • parameter watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resource_version.

val post : ?pretty:string -> namespace:string -> body:Kubernetes.Definitions.Api.Extensions.V1beta1.Ingress.t -> ?ctx:Cohttp_lwt_unix.Client.ctx -> ?headers:Cohttp.Header.t -> Uri.t -> (Kubernetes.Definitions.Api.Extensions.V1beta1.Ingress.t, string) Stdlib.result Lwt.t

create an Ingress

  • parameter pretty

    If 'true', then the output is pretty printed.

  • parameter namespace

    object name and auth scope, such as for teams and projects

val delete : ?pretty:string -> namespace:string -> ?continue:string -> ?field_selector:string -> ?include_uninitialized:bool -> ?label_selector:string -> ?limit:int -> ?resource_version:string -> ?timeout_seconds:int -> ?watch:bool -> ?ctx:Cohttp_lwt_unix.Client.ctx -> ?headers:Cohttp.Header.t -> Uri.t -> (Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Status.t, string) Stdlib.result Lwt.t

delete collection of Ingress

  • parameter pretty

    If 'true', then the output is pretty printed.

  • parameter namespace

    object name and auth scope, such as for teams and projects

  • parameter continue

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 Resource_expired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resource_version value returned by the server and not miss any modifications.

  • parameter field_selector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • parameter include_uninitialized

    If true, partially initialized resources are included in the response.

  • parameter label_selector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • parameter limit

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    the server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

  • parameter resource_version

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum_read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

  • parameter timeout_seconds

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

  • parameter watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resource_version.

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