elasticsearch v1.0.0 Elasticsearch.API behaviour View Source

Behaviour for interacting with the Elasticsearch JSON API.

Link to this section Summary

data()

A payload of data to send, relevant to :put and :post requests

An HTTP method

opts()

A keyword list of options to pass to HTTPoison/Hackney

url()

The URL to request from the API

Makes a request to an Elasticsearch JSON API URl using the given method

data() :: binary() | map() | Keyword.t()

A payload of data to send, relevant to :put and :post requests

method() :: :get | :put | :post | :delete

An HTTP method

opts() :: Keyword.t()

A keyword list of options to pass to HTTPoison/Hackney

response()

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

url() :: String.t()

The URL to request from the API

request(config, method, url, data, opts)

request(
  config :: Elasticsearch.Cluster.config(),
  method(),
  url(),
  data(),
  opts()
) :: response()

Makes a request to an Elasticsearch JSON API URl using the given method.