influx_ex v0.3.1

InfluxEx.HTTP.Request (influx_ex v0.3.1)

A request to InfluxDB

Link to this section Summary

Types

headers()
method()
opt()
payload()
request_handler()
t()
url()

Functions

new(endpoint, opts \\ [])

Make a new Request.t()

run(request, client)

Link to this section Types

Link to this type

headers()

@type headers() :: [{binary(), binary()}]
Link to this type

method()

@type method() :: :get | :post | :delete
Link to this type

opt()

@type opt() ::
  {:payload, term()}
  | {:method, method()}
  | {:query_params, map()}
  | {:handler, request_handler()}
Link to this type

payload()

@type payload() :: binary() | map()
Link to this type

request_handler()

@type request_handler() ::
  (InfluxEx.HTTP.Response.t() -> term() | {:error, InfluxEx.GenericError.t()})
Link to this type

t()

@type t() :: %InfluxEx.HTTP.Request{
  endpoint: binary(),
  handler: request_handler() | nil,
  method: method(),
  payload: payload() | nil,
  query_params: map()
}
Link to this type

url()

@type url() :: binary()

Link to this section Functions

Link to this function

new(endpoint, opts \\ [])

@spec new(binary(), [opt()]) :: t()

Make a new Request.t()

Link to this function

run(request, client)