View Source K8s.Client.Runner.Stream (k8s v1.1.5)

Takes a K8s.Client.list/3 operation and returns an Elixir Stream of resources.

Link to this section Summary

halt_t()

Halt streaming

state_t()

List of items and pagination request

Validates operation type before calling stream/3. Only supports verbs: list_all_namespaces and list.

Returns an elixir stream of paginated list results.

@type halt_t() :: {:halt, state_t()}

Halt streaming

@type state_t() :: {list(), K8s.Client.Runner.Stream.ListRequest.t()}

List of items and pagination request

@spec run(K8s.Conn.t(), K8s.Operation.t(), keyword()) ::
  {:ok, Enumerable.t()} | {:error, K8s.Operation.Error.t()}

Validates operation type before calling stream/3. Only supports verbs: list_all_namespaces and list.

@spec stream(K8s.Conn.t(), K8s.Operation.t(), keyword() | nil) :: Enumerable.t()

Returns an elixir stream of paginated list results.

Elements in stream will be HTTP bodies, or error tuples.

Encountering an HTTP error mid-stream will halt the stream.