View Source Kubegen.K8sClient.ExampleCom.V1alpha1.Foo.Scale (kubegen v0.1.2)

Summary

Functions

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

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

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

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

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

Wait until the given callback resolves to true for a resource of kind foos/scale in apiVersion example.com/v1alpha1.

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

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

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

Get the resource of kind foos/scale in apiVersion example.com/v1alpha1 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 foos/scale in apiVersion example.com/v1alpha1 with the given json_patch.

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 foos/scale in apiVersion example.com/v1alpha1 with the given merge_patch.

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

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

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 foos/scale 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.