View Source Consul.Request (consulex v0.2.1)
This module is used to build an HTTP request
Link to this section Summary
Functions
Add optional parameters to the request
Add optional parameters to the request
Specify the request method when building a request
Specify the request URL when building a request
Link to this section Types
Specs
method() :: :head | :get | :delete | :trace | :options | :post | :put | :patch
Specs
param_location() :: :body | :query | :header
Specs
Link to this section Functions
Specs
add_optional_params( t(), %{optional(atom()) => param_location()}, keyword() ) :: t()
Add optional parameters to the request
parameters
Parameters
request
(type:Consul.Request.t
) - Collected request optionsdefinitions
(type:Map
) - Map of parameter name to parameter locationoptions
(type:keyword()
) - The provided optional parameters
returns
Returns
Consul.Request.t
Specs
add_param(t(), param_location(), atom(), any()) :: t()
Add optional parameters to the request
parameters
Parameters
request
(type:Consul.Request.t
) - Collected request optionslocation
(type:atom()
) - Where to put the parameterkey
(type:atom()
) - The name of the parametervalue
(type:any()
) - The value of the parameter
returns
Returns
Consul.Request.t
Specs
Specs
Specify the request method when building a request
parameters
Parameters
request
(type:Consul.Request.t
) - Collected request optionsm
(type:String
) - Request method
returns
Returns
Consul.Request.t
Specs
new() :: t()
Specs
Specs
Specify the request URL when building a request
parameters
Parameters
request
(type:Consul.Request.t
) - Collected request optionsu
(type:String
) - Request URL
returns
Returns
Consul.Request.t