ExAzureCore.Http.Response (ex_azure_core v0.2.0)

Represents an HTTP response from Azure services.

Provides normalized access to response data with helper functions for common status code checks and header access.

Creating from Req Response

{:ok, req_response} = Req.request(opts)
response = ExAzureCore.Http.Response.from_req(req_response)

Checking Status

if Response.success?(response) do
  process(response.body)
end

Summary

Types

t()

Functions

client_error?(response)

Returns true if the response has a 4xx status code.

content_type(response)

Gets the Content-Type header value.

from_req(req_response)

Creates a Response from a Req.Response struct.

get_header(response, name)

Gets a header value by name (case-insensitive).

get_retry_after(response)

Gets the Retry-After header value as an integer (seconds).

rate_limited?(response)

Returns true if the response is rate limited (429).

redirect?(response)

Returns true if the response is a redirect (3xx).

server_error?(response)

Returns true if the response has a 5xx status code.

success?(response)

Returns true if the response has a 2xx status code.

Types

t()

@type t() :: %ExAzureCore.Http.Response{
  body: term(),
  client_request_id: String.t() | nil,
  headers: %{required(String.t()) => String.t()},
  request_id: String.t() | nil,
  status: integer()
}

Functions

client_error?(response)

@spec client_error?(t()) :: boolean()

Returns true if the response has a 4xx status code.

content_type(response)

@spec content_type(t()) :: String.t() | nil

Gets the Content-Type header value.

from_req(req_response)

@spec from_req(Req.Response.t()) :: t()

Creates a Response from a Req.Response struct.

get_header(response, name)

@spec get_header(t(), String.t()) :: String.t() | nil

Gets a header value by name (case-insensitive).

Returns nil if the header is not present.

get_retry_after(response)

@spec get_retry_after(t()) :: non_neg_integer() | nil

Gets the Retry-After header value as an integer (seconds).

Returns nil if the header is not present or cannot be parsed. Azure services return Retry-After as seconds.

rate_limited?(response)

@spec rate_limited?(t()) :: boolean()

Returns true if the response is rate limited (429).

redirect?(response)

@spec redirect?(t()) :: boolean()

Returns true if the response is a redirect (3xx).

server_error?(response)

@spec server_error?(t()) :: boolean()

Returns true if the response has a 5xx status code.

success?(response)

@spec success?(t()) :: boolean()

Returns true if the response has a 2xx status code.