k8s v1.1.1

View Source K8s.Client.Provider behaviour (k8s v1.1.1)

HTTP Request / Response provider behaviour

Link to this section Summary

Types

error_t()
response_t()
success_t()

Callbacks

handle_response(arg1)

Handle HTTP Responses

headers(t)

Generate headers for HTTP Requests

headers(atom, t)

Deprecated! Use headers/1 instead

request(atom, binary, binary, keyword, keyword)

Perform HTTP Requests

Link to this section Types

Link to this type

error_t()

View Source

Specs

error_t() ::
  {:error,
   K8s.Client.APIError.t() | HTTPoison.Response.t() | HTTPoison.Error.t()}
Link to this type

response_t()

View Source

Specs

response_t() :: success_t() | error_t()
Link to this type

success_t()

View Source

Specs

success_t() :: {:ok, [map()] | map() | reference() | binary() | [binary()]}

Link to this section Callbacks

Link to this callback

handle_response(arg1)

View Source

Specs

handle_response(
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}
) :: response_t()

Handle HTTP Responses

Link to this callback

headers(t)

View Source

Specs

headers(K8s.Conn.RequestOptions.t()) :: keyword()

Generate headers for HTTP Requests

Link to this callback

headers(atom, t)

View Source

Specs

headers(atom(), K8s.Conn.RequestOptions.t()) :: [{binary(), binary()}]

Deprecated! Use headers/1 instead

Link to this callback

request(atom, binary, binary, keyword, keyword)

View Source

Specs

request(atom(), binary(), binary(), keyword(), keyword()) :: response_t()

Perform HTTP Requests