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

Server-Side applies the given resources of kind foos in apiVersion example.com/v1alpha1.

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 foos in apiVersion example.com/v1alpha1.

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

Deletes the resource of kind foos in apiVersion example.com/v1alpha1 with name in namespace.

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

Deletes all the resources of kind foos in apiVersion example.com/v1alpha1 in namespace.

Options

• :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.

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

Get the resource of kind foos in apiVersion example.com/v1alpha1 by name.

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

Patches the given resource of kind foos in apiVersion example.com/v1alpha1 with the given json_patch.

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

List resources of kind foos in apiVersion example.com/v1alpha1 in all namespaces.

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

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

List resources of kind foos in apiVersion example.com/v1alpha1 in all namespaces.

Options

• :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.

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

List resources of kind foos in apiVersion example.com/v1alpha1 in the given namespace.

Options

• :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.

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

Patches the given resource of kind foos in apiVersion example.com/v1alpha1 with the given merge_patch.

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

Updates the given resource of kind foos in apiVersion example.com/v1alpha1.

@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 foos in apiVersion example.com/v1alpha1.

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 foos in apiVersion example.com/v1alpha1 in all namespaces.

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

Watches for events on all resources of kind foos in apiVersion example.com/v1alpha1 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.

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

Watches for events on all resources of kind foos in apiVersion example.com/v1alpha1 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.

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

Watches for events on a single resource of kind foos in apiVersion example.com/v1alpha1 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.