View Source AliyunOpenAPI.HTTP.Request (aliyun_open_api v0.6.0)

A struct representing an HTTP request.

Summary

Types

body()

Optional request body.

headers()

Request headers.

host()

Request host.

method()

Request method.

path()

Request path.

query()

Optional request query.

scheme()

Request scheme.

t()

Functions

from_spec!(spec)

Creates an HTTP request struct from spec.

new!(args)

Creates an HTTP request struct.

put_body(request, value)

put_header(request, name, fun)

put_new_header(request, name, fun)

put_new_query(request, name, fun)

put_query(request, name, fun)

url(request)

Gets the url string of an HTTP request struct.

Types

body()

@type body() :: iodata() | nil

Optional request body.

headers()

@type headers() :: %{optional(name :: String.t()) => value :: String.t()}

Request headers.

host()

@type host() :: String.t()

Request host.

method()

@type method() :: String.t()

Request method.

path()

@type path() :: String.t()

Request path.

query()

@type query() :: %{
  optional(name :: String.t()) => value :: boolean() | number() | String.t()
}

Optional request query.

scheme()

@type scheme() :: String.t()

Request scheme.

t()

@type t() :: %AliyunOpenAPI.HTTP.Request{
  body: body(),
  headers: headers(),
  host: host(),
  method: method(),
  path: path(),
  port: :inet.port_number(),
  query: query(),
  scheme: scheme()
}

Functions

from_spec!(spec)

Creates an HTTP request struct from spec.

new!(args)

Creates an HTTP request struct.

put_body(request, value)

put_header(request, name, fun)

put_new_header(request, name, fun)

put_new_query(request, name, fun)

put_query(request, name, fun)

url(request)

Gets the url string of an HTTP request struct.