View Source DockerEngineAPI.RequestBuilder (docker_engine_api v1.43.0)

Helper functions for building Tesla requests

Summary

Functions

Add optional parameters to the request

Add optional parameters to the request

Handle the response for a Tesla request

Specify the request method when building a request

Specify the request method when building a request

Functions

Link to this function

add_optional_params(request, definitions, list)

View Source

Add optional parameters to the request

Parameters

  • request (Map) - Collected request options
  • definitions (Map) - Map of parameter name to parameter location.
  • options (KeywordList) - The provided optional parameters

Returns

Map

Link to this function

add_param(request, location, key, value)

View Source

Add optional parameters to the request

Parameters

  • request (Map) - Collected request options
  • location (atom) - Where to put the parameter
  • key (atom) - The name of the parameter
  • value (any) - The value of the parameter

Returns

Map

Handle the response for a Tesla request

Parameters

  • arg1 (Tesla.Env.t | term) - The response object

  • arg2 (:false | struct | [struct]) - The shape of the struct to deserialize into

Returns

on success {:error, term} on failure

Specify the request method when building a request

Parameters

  • request (Map) - Collected request options
  • m (atom) - Request method

Returns

Map

Specify the request method when building a request

Parameters

  • request (Map) - Collected request options
  • u (String) - Request URL

Returns

Map