View Source Kubegen.K8sClient.Core.V1.ConfigMap (kubegen v0.1.2)

Summary

Functions

Server-Side applies the given resources of kind configmaps in apiVersion v1.

Create a resource of kind configmaps in apiVersion v1.

Deletes the resource of kind configmaps in apiVersion v1 with name in namespace.

Deletes all the resources of kind configmaps in apiVersion v1 in namespace.

Get the resource of kind configmaps in apiVersion v1 by name.

Patches the given resource of kind configmaps in apiVersion v1 with the given json_patch.

List resources of kind configmaps in apiVersion v1 in all namespaces.

List resources of kind configmaps in apiVersion v1 in all namespaces.

List resources of kind configmaps in apiVersion v1 in the given namespace.

Patches the given resource of kind configmaps in apiVersion v1 with the given merge_patch.

Updates the given resource of kind configmaps in apiVersion v1.

Wait until the given callback resolves to true for a resource of kind configmaps in apiVersion v1.

Watches for events on all resources of kind configmaps in apiVersion v1 in all namespaces.

Watches for events on all resources of kind configmaps in apiVersion v1 in all namespaces.

Watches for events on all resources of kind configmaps in apiVersion v1 in the given namespace.

Watches for events on a single resource of kind configmaps in apiVersion v1 in the given namespace.

Functions

Link to this function

apply(resource, field_manager \\ "Elixir", force \\ true)

View Source
@spec apply(resource :: map(), field_manager :: String.t(), force :: boolean()) ::
  Kubereq.response()

Server-Side applies the given resources of kind configmaps in apiVersion v1.

In order to understand field_manager and force, refer to the Kubernetes documentation about Field Management

@spec create(resource :: map()) :: Kubereq.response()

Create a resource of kind configmaps in apiVersion v1.

@spec delete(namespace :: String.t(), name :: Kubereq.namespace()) ::
  Kubereq.response()

Deletes the resource of kind configmaps in apiVersion v1 with name in namespace.

Link to this function

delete_all(namespace, opts \\ [])

View Source
@spec delete_all(namespace :: Kubereq.namespace(), opts :: keyword()) ::
  Kubereq.response()

Deletes all the resources of kind configmaps in apiVersion v1 in namespace.

Options

@spec get(namespace :: Kubereq.namespace(), name :: String.t()) :: Kubereq.response()

Get the resource of kind configmaps in apiVersion v1 by name.

Link to this function

json_patch(name, namespace, json_patch)

View Source
@spec json_patch(
  name :: String.t(),
  namespace :: Kubereq.namespace(),
  json_patch :: map()
) ::
  Kubereq.response()

Patches the given resource of kind configmaps in apiVersion v1 with the given json_patch.

@spec list() :: Kubereq.response()

List resources of kind configmaps in apiVersion v1 in all namespaces.

@spec list(opts :: Keyword.t()) :: Kubereq.response()
@spec list(namespace :: Kubereq.namespace()) :: Kubereq.response()

List resources of kind configmaps in apiVersion v1 in all namespaces.

Options

Link to this function

list(namespace, opts \\ [])

View Source
@spec list(namespace :: Kubereq.namespace(), opts :: Keyword.t()) ::
  Kubereq.response()

List resources of kind configmaps in apiVersion v1 in the given namespace.

Options

Link to this function

merge_patch(name, namespace, merge_patch)

View Source
@spec merge_patch(
  name :: String.t(),
  namespace :: Kubereq.namespace(),
  merge_patch :: String.t()
) :: Kubereq.response()

Patches the given resource of kind configmaps in apiVersion v1 with the given merge_patch.

@spec update(resource :: map()) :: Kubereq.response()

Updates the given resource of kind configmaps in apiVersion v1.

Link to this function

wait_until(namespace, name, callback, timeout \\ 10000)

View Source
@spec wait_until(
  namespace :: Kubereq.namespace(),
  name :: String.t(),
  callback :: Kubereq.wait_until_callback(),
  timeout :: integer()
) :: Kubereq.wait_until_response()

Wait until the given callback resolves to true for a resource of kind configmaps in apiVersion v1.

Callback Args and Result

The given callback is called with the resource as argument. If the resource was deleted, :deleted is passed as argument. The callback should return a boolean.

Options

  • timeout - Timeout in ms after function terminates with {:error, :timeout}. Defaults to 10_000.
@spec watch() :: Kubereq.watch_response()

Watches for events on all resources of kind configmaps in apiVersion v1 in all namespaces.

@spec watch(opts :: keyword()) :: Kubereq.watch_response()

Watches for events on all resources of kind configmaps in apiVersion v1 in all namespaces.

Options

  • :resource_version - If given, starts to stream from the given resourceVersion of the resource list. Otherwise starts streaming from HEAD.
  • :stream_to - If set to a pid, streams events to the given pid. If set to {pid, ref}, the messages are in the form {ref, event}.
  • :field_selectors - A list of field selectors. See Kubereq.Step.FieldSelector for more infos.
  • :label_selectors - A list of field selectors. See Kubereq.Step.LabelSelector for more infos.
Link to this function

watch(namespace, opts \\ [])

View Source
@spec watch(namespace :: Kubereq.namespace(), opts :: keyword()) ::
  Kubereq.watch_response()

Watches for events on all resources of kind configmaps in apiVersion v1 in the given namespace.

Options

  • :resource_version - If given, starts to stream from the given resourceVersion of the resource list. Otherwise starts streaming from HEAD.
  • :stream_to - If set to a pid, streams events to the given pid. If set to {pid, ref}, the messages are in the form {ref, event}.
  • :field_selectors - A list of field selectors. See Kubereq.Step.FieldSelector for more infos.
  • :label_selectors - A list of field selectors. See Kubereq.Step.LabelSelector for more infos.
Link to this function

watch_single(namespace, name, opts \\ [])

View Source
@spec watch_single(namespace :: binary(), name :: binary(), opts :: keyword()) ::
  Kubereq.watch_response()

Watches for events on a single resource of kind configmaps in apiVersion v1 in the given namespace.

Options

  • :resource_version - If given, starts to stream from the given resourceVersion of the resource list. Otherwise starts streaming from HEAD.
  • :stream_to - If set to a pid, streams events to the given pid. If set to {pid, ref}, the messages are in the form {ref, event}.
  • :field_selectors - A list of field selectors. See Kubereq.Step.FieldSelector for more infos.
  • :label_selectors - A list of field selectors. See Kubereq.Step.LabelSelector for more infos.