Cloudsight API

v0.4.0

Cloudsight API v0.4.0 CloudsightElixir.Api

Core functions for interfacing with the API

Link to this section Summary

Types

body()
headers()

Functions

delete!(url, headers \\ [], options \\ [])

Issues a DELETE request to the given url, raising an exception in case of failure

delete(url, headers \\ [], options \\ [])

Issues a DELETE request to the given url

get!(url, headers \\ [], options \\ [])

Issues a GET request to the given url, raising an exception in case of failure

get(path, client)

Callback implementation for HTTPoison.Base.get/2

get(url, headers \\ [], options \\ [])

Issues a GET request to the given url

handle_response(response)
head!(url, headers \\ [], options \\ [])

Issues a HEAD request to the given url, raising an exception in case of failure

head(url, headers \\ [], options \\ [])

Issues a HEAD request to the given url

headers_for(method, url, client, params)
options!(url, headers \\ [], options \\ [])

Issues a OPTIONS request to the given url, raising an exception in case of failure

options(url, headers \\ [], options \\ [])

Issues an OPTIONS request to the given url

patch!(url, body, headers \\ [], options \\ [])

Issues a PATCH request to the given url, raising an exception in case of failure

patch(url, body, headers \\ [], options \\ [])

Issues a PATCH request to the given url

post!(url, body, headers \\ [], options \\ [])

Issues a POST request to the given url, raising an exception in case of failure

post(path, params, client)

Callback implementation for HTTPoison.Base.post/3

post(url, body, headers \\ [], options \\ [])

Issues a POST request to the given url

process_headers(headers)

Callback implementation for HTTPoison.Base.process_headers/1

process_request_body(body)

Callback implementation for HTTPoison.Base.process_request_body/1

process_request_headers(headers)

Callback implementation for HTTPoison.Base.process_request_headers/1

process_request_options(options)

Callback implementation for HTTPoison.Base.process_request_options/1

process_response_body(body)

Callback implementation for HTTPoison.Base.process_response_body/1

process_response_chunk(chunk)

Callback implementation for HTTPoison.Base.process_response_chunk/1

process_status_code(status_code)

Callback implementation for HTTPoison.Base.process_status_code/1

process_url(url)

Callback implementation for HTTPoison.Base.process_url/1

process_url(path, client)
put!(url, body \\ "", headers \\ [], options \\ [])

Issues a PUT request to the given url, raising an exception in case of failure

put(url, body \\ "", headers \\ [], options \\ [])

Issues a PUT request to the given url

raw_request(method, url, body \\ "", headers \\ [])
request!(method, url, body \\ "", headers \\ [], options \\ [])

Issues an HTTP request with the given method to the given url, raising an exception in case of failure

request(method, url, body \\ "", headers \\ [], options \\ [])

Issues an HTTP request with the given method to the given url

start()

Starts HTTPoison and its dependencies

stream_next(resp)

Requests the next message to be streamed for a given HTTPoison.AsyncResponse

Link to this section Types

Link to this section Functions

Link to this function delete!(url, headers \\ [], options \\ []) 
delete!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a DELETE request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function delete(url, headers \\ [], options \\ []) 
delete(binary(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a DELETE request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function get!(url, headers \\ [], options \\ []) 
get!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a GET request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function get(path, client) 
get(binary(), CloudsightElixir.Client.t()) :: {atom(), map()}

Callback implementation for HTTPoison.Base.get/2.

Link to this function get(url, headers \\ [], options \\ []) 
get(binary(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a GET request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function handle_response(response) 
handle_response(HTTPoison.Response.t()) :: {atom(), map()}
Link to this function head!(url, headers \\ [], options \\ []) 
head!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a HEAD request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function head(url, headers \\ [], options \\ []) 
head(binary(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a HEAD request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function headers_for(method, url, client, params)
Link to this function options!(url, headers \\ [], options \\ []) 
options!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a OPTIONS request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function options(url, headers \\ [], options \\ []) 
options(binary(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues an OPTIONS request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function patch!(url, body, headers \\ [], options \\ []) 
patch!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a PATCH request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function patch(url, body, headers \\ [], options \\ []) 
patch(binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a PATCH request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function post!(url, body, headers \\ [], options \\ []) 
post!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a POST request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function post(path, params, client) 
post(binary(), map(), CloudsightElixir.Client.t()) :: {atom(), map()}

Callback implementation for HTTPoison.Base.post/3.

Link to this function post(url, body, headers \\ [], options \\ []) 
post(binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a POST request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function process_headers(headers)

Callback implementation for HTTPoison.Base.process_headers/1.

Link to this function process_request_body(body) 
process_request_body(any()) :: body()

Callback implementation for HTTPoison.Base.process_request_body/1.

Link to this function process_request_headers(headers) 
process_request_headers(headers()) :: headers()

Callback implementation for HTTPoison.Base.process_request_headers/1.

Link to this function process_request_options(options)

Callback implementation for HTTPoison.Base.process_request_options/1.

Link to this function process_response_body(body) 
process_response_body(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_body/1.

Link to this function process_response_chunk(chunk)

Callback implementation for HTTPoison.Base.process_response_chunk/1.

Link to this function process_status_code(status_code)

Callback implementation for HTTPoison.Base.process_status_code/1.

Link to this function process_url(url)

Callback implementation for HTTPoison.Base.process_url/1.

Link to this function process_url(path, client) 
process_url(binary(), CloudsightElixir.Client.t()) :: binary()
Link to this function put!(url, body \\ "", headers \\ [], options \\ []) 
put!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a PUT request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

Link to this function put(url, body \\ "", headers \\ [], options \\ []) 
put(binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a PUT request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

Link to this function raw_request(method, url, body \\ "", headers \\ []) 
raw_request(:get | :post, binary(), binary(), list()) :: HTTPoison.Response.t()
Link to this function request!(method, url, body \\ "", headers \\ [], options \\ []) 
request!(atom(), binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues an HTTP request with the given method to the given url, raising an exception in case of failure.

request!/5 works exactly like request/5 but it returns just the response in case of a successful request, raising an exception in case the request fails.

Link to this function request(method, url, body \\ "", headers \\ [], options \\ []) 
request(atom(), binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues an HTTP request with the given method to the given url.

This function is usually used indirectly by get/3, post/4, put/4, etc

Args:

  • method - HTTP method as an atom (:get, :head, :post, :put, :delete, etc.)
  • url - target url as a binary string or char list
  • body - request body. See more below
  • headers - HTTP headers as an orddict (e.g., [{"Accept", "application/json"}])
  • options - Keyword list of options

Body:

  • binary, char list or an iolist
  • {:form, [{K, V}, ...]} - send a form url encoded
  • {:file, "/path/to/file"} - send a file
  • {:stream, enumerable} - lazily send a stream of binaries/charlists

Options:

  • :timeout - timeout to establish a connection, in milliseconds. Default is 8000
  • :recv_timeout - timeout used when receiving a connection. Default is 5000
  • :stream_to - a PID to stream the response to
  • :async - if given :once, will only stream one message at a time, requires call to stream_next
  • :proxy - a proxy to be used for the request; it can be a regular url or a {Host, Port} tuple, or a `{:socks5, ProxyHost, ProxyPort} tuple
  • :proxy_auth - proxy authentication {User, Password} tuple
  • :socks5_user- socks5 username
  • :socks5_pass- socks5 password
  • :ssl - SSL options supported by the ssl erlang module
  • :follow_redirect - a boolean that causes redirects to be followed
  • :max_redirect - an integer denoting the maximum number of redirects to follow
  • :params - an enumerable consisting of two-item tuples that will be appended to the url as query string parameters

Timeouts can be an integer or :infinity

This function returns {:ok, response} or {:ok, async_response} if the request is successful, {:error, reason} otherwise.

Examples 

request(:post, "https://my.website.com", "{\"foo\": 3}", [{"Accept", "application/json"}])
Link to this function start()

Starts HTTPoison and its dependencies.

Link to this function stream_next(resp) 
stream_next(HTTPoison.AsyncResponse.t()) ::
  {:ok, HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}

Requests the next message to be streamed for a given HTTPoison.AsyncResponse.

See request!/5 for more detailed information.