QlikElixir.REST.Reloads (qlik_elixir v0.3.5)

View Source

Qlik Cloud Reloads REST API client.

Provides functions to trigger and manage app reloads.

API Reference: https://qlik.dev/apis/rest/reloads/

Summary

Functions

Cancels a queued or running reload.

Creates a new reload for an app.

Gets details for a specific reload.

Lists reloads.

Functions

cancel(reload_id, opts \\ [])

@spec cancel(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Cancels a queued or running reload.

Examples

iex> QlikElixir.REST.Reloads.cancel("reload-123")
{:ok, %{"id" => "reload-123", "status" => "CANCELING"}}

create(app_id, opts \\ [])

@spec create(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Creates a new reload for an app.

Options

  • :partial - Whether to perform a partial reload (default: false)
  • :config - Custom configuration

Examples

iex> QlikElixir.REST.Reloads.create("app-123")
{:ok, %{"id" => "reload-new", "status" => "QUEUED"}}

iex> QlikElixir.REST.Reloads.create("app-123", partial: true)
{:ok, %{"id" => "reload-new", "status" => "QUEUED"}}

get(reload_id, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Gets details for a specific reload.

Examples

iex> QlikElixir.REST.Reloads.get("reload-123")
{:ok, %{"id" => "reload-123", "status" => "SUCCEEDED"}}

list(opts \\ [])

@spec list(keyword()) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Lists reloads.

Options

  • :app_id - Filter by app ID
  • :status - Filter by status (QUEUED, RELOADING, SUCCEEDED, FAILED, CANCELING, CANCELED)
  • :limit - Maximum number of reloads to return
  • :next - Cursor for pagination
  • :config - Custom configuration

Examples

iex> QlikElixir.REST.Reloads.list(app_id: "app-123")
{:ok, %{"data" => [...]}}