Liking cljdoc? Tell your friends :D

clj-oci.identity

OCI Identity API wrapper.

Provides paginated compartment listing via list-compartments and non-paginated availability domain listing via list-availability-domains. Uses clojure.java.data.builder/to-java with :limit pre-coerced to Integer and :accessLevel passed as the Java enum constant directly to satisfy SDK setter types under cloverage instrumentation.

Results are cached via service.memo — subsequent calls with the same tenancy-id return cached data unless :refresh? is set.

OCI Identity API wrapper.

Provides paginated compartment listing via `list-compartments` and
non-paginated availability domain listing via `list-availability-domains`.
Uses `clojure.java.data.builder/to-java` with `:limit` pre-coerced to
`Integer` and `:accessLevel` passed as the Java enum constant directly
to satisfy SDK setter types under cloverage instrumentation.

Results are cached via `service.memo` — subsequent calls with the same
tenancy-id return cached data unless `:refresh?` is set.
raw docstring

availability-domain-namesclj

(availability-domain-names tenancy-id)

Returns all availability domain name strings for tenancy-id.

Convenience wrapper over list-availability-domains. Returns {:data ["FDlC:PHX-AD-1" ...]} or {:error ...}.

Returns all availability domain name strings for `tenancy-id`.

Convenience wrapper over `list-availability-domains`.
Returns {:data ["FDlC:PHX-AD-1" ...]} or {:error ...}.
raw docstring

compartment-idsclj

(compartment-ids tenancy-id)

Returns all compartment OCIDs under tenancy-id as a flat vector.

Convenience wrapper over list-compartments. Returns {:data [ocid-strings...]} or {:error ...}.

Returns all compartment OCIDs under `tenancy-id` as a flat vector.

Convenience wrapper over `list-compartments`.
Returns {:data [ocid-strings...]} or {:error ...}.
raw docstring

list-availability-domainsclj

(list-availability-domains tenancy-id)

Returns all availability domains visible to tenancy-id.

The Identity API does not paginate this endpoint (typically 3 ADs). Returns {:data {:items [ad-maps...]}} or {:error ...}. Each ad-map has :name (e.g. "FDlC:PHX-AD-1"), :id, and :compartmentId.

Returns all availability domains visible to `tenancy-id`.

The Identity API does not paginate this endpoint (typically 3 ADs).
Returns {:data {:items [ad-maps...]}} or {:error ...}.
Each ad-map has :name (e.g. "FDlC:PHX-AD-1"), :id, and :compartmentId.
raw docstring

list-compartmentsclj

(list-compartments tenancy-id)
(list-compartments tenancy-id
                   {:keys [limit max-age-seconds refresh?]
                    :or {limit 1000 refresh? false}})

Fetches all compartments under tenancy-id, paginating automatically.

Uses :compartmentIdInSubtree true and AccessLevel/Any to return all compartments in the tenancy hierarchy.

Results are cached in Datahike; subsequent calls with the same tenancy-id return cached data.

Returns {:data {:items [compartment-maps...]}} or {:error ...} on failure. Each compartment map has camelCase keyword keys as produced by from-java, e.g. :id, :name, :lifecycleState, :compartmentId.

Options: :limit — page size (default 1000) :refresh? — force re-fetch from OCI, replacing cached data (default false) :max-age-seconds — re-fetch if cached entry is older than this (default nil = no limit)

Fetches all compartments under `tenancy-id`, paginating automatically.

Uses `:compartmentIdInSubtree true` and `AccessLevel/Any` to return all
compartments in the tenancy hierarchy.

Results are cached in Datahike; subsequent calls with the same
tenancy-id return cached data.

Returns {:data {:items [compartment-maps...]}} or {:error ...} on failure.
Each compartment map has camelCase keyword keys as produced by `from-java`,
e.g. :id, :name, :lifecycleState, :compartmentId.

Options:
  :limit           — page size (default 1000)
  :refresh?        — force re-fetch from OCI, replacing cached data (default false)
  :max-age-seconds — re-fetch if cached entry is older than this (default nil = no limit)
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