Liking cljdoc? Tell your friends :D

clj-oci.oci


client-method-paramsclj

(client-method-params client method)

Returns the construction schema for method's parameter type on client.

The schema describes how to build the request object: buildable sub-types appear as nested sorted-maps, enums include :enum-values, and List<T> fields include :type-args.

Returns the construction schema for `method`'s parameter type on `client`.

The schema describes how to build the request object: buildable sub-types
appear as nested sorted-maps, enums include `:enum-values`, and `List<T>`
fields include `:type-args`.
raw docstring

close!clj

(close!)

Releases the Datahike cache store connection. Call this when your application shuts down to ensure clean resource release.

Releases the Datahike cache store connection.  Call this when your
application shuts down to ensure clean resource release.
raw docstring

enum-registryclj

(enum-registry doc)

Given an oci-doc output map, returns a registry mapping each enum Class to a map of {keyword => enum-constant} for all enums used in the API.

Keywords are derived from the enum constant's .name converted to kebab-case lowercase (e.g., Hourly -> :hourly, AllCredit -> :all-credit).

Given an `oci-doc` output map, returns a registry mapping each enum Class
to a map of {keyword => enum-constant} for all enums used in the API.

Keywords are derived from the enum constant's `.name` converted to kebab-case
lowercase (e.g., Hourly -> :hourly, AllCredit -> :all-credit).
raw docstring

http-requestclj

(http-request request-fn parameters)
(http-request request-fn
              parameters
              {:keys [max-retries initial-delay-ms]
               :or {max-retries 3 initial-delay-ms 1000}})

Send an OCI request using request-fn with parameters. Returns a map with either :data or :error.

Retries on transient failures (429, 5xx) with exponential backoff. Options: :max-retries — maximum retry attempts (default 3) :initial-delay-ms — base delay in ms before first retry (default 1000)

java.util.Date values pass through from-java unchanged (via the :clojure.java.data/do-not-convert derive in service.model).

Send an OCI request using `request-fn` with `parameters`.
Returns a map with either :data or :error.

Retries on transient failures (429, 5xx) with exponential backoff.
Options:
  :max-retries       — maximum retry attempts (default 3)
  :initial-delay-ms  — base delay in ms before first retry (default 1000)

java.util.Date values pass through `from-java` unchanged (via the
:clojure.java.data/do-not-convert derive in service.model).
raw docstring

oci-docclj

(oci-doc client)

Returns a sorted-map documenting every request method of an OCI client and its (nested) parameter types.

Each key is a method keyword (e.g. :requestSummarizedUsages), and each value is a schema describing the method's parameter type. Use the output with enum-registry and oci-build to construct request objects from plain Clojure maps.

Returns a sorted-map documenting every request method of an OCI `client`
and its (nested) parameter types.

Each key is a method keyword (e.g. `:requestSummarizedUsages`), and each
value is a schema describing the method's parameter type. Use the output
with `enum-registry` and `oci-build` to construct request objects from
plain Clojure maps.
raw docstring

paginateclj

(paginate request-fn build-request items-key)

Fetches all pages of a paginated OCI API response.

Arguments: request-fn — fn called with a built request object, e.g. #(.listInstances client %) build-request — (fn [page-token-or-nil] -> Java request object) items-key — keyword to extract items from each page (e.g. :items)

Loops on :opcNextPage (camelCase, as produced by from-java) until exhausted. Returns {:data {items-key [all-accumulated-items]}} or {:error ...} on first failure.

Fetches all pages of a paginated OCI API response.

Arguments:
  request-fn    — fn called with a built request object, e.g. #(.listInstances client %)
  build-request — (fn [page-token-or-nil] -> Java request object)
  items-key     — keyword to extract items from each page (e.g. :items)

Loops on :opcNextPage (camelCase, as produced by from-java) until exhausted.
Returns {:data {items-key [all-accumulated-items]}} or {:error ...} on first failure.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close