Liking cljdoc? Tell your friends :D

clj-oci.compute

OCI Compute API wrapper.

Provides paginated instance listing via list-instances. Uses clojure.java.data.builder/to-java with :limit pre-coerced to Integer to satisfy the SDK setter type while remaining compatible with cloverage instrumentation.

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

OCI Compute API wrapper.

Provides paginated instance listing via `list-instances`. Uses
`clojure.java.data.builder/to-java` with `:limit` pre-coerced to
`Integer` to satisfy the SDK setter type while remaining compatible
with cloverage instrumentation.

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

clj-oci.filestorage

OCI FileStorage API wrapper.

Provides paginated filesystem listing via list-file-systems. Requires both compartment-id and availability-domain — unlike Compute, the FileStorage API mandates an AD per request.

Uses clojure.java.data.builder/to-java with :limit pre-coerced to Integer to satisfy the SDK setter type under cloverage instrumentation.

Results are cached via service.memo keyed by compartment-id and availability-domain — subsequent calls with the same params return cached data unless :refresh? is set.

OCI FileStorage API wrapper.

Provides paginated filesystem listing via `list-file-systems`. Requires
both `compartment-id` and `availability-domain` — unlike Compute, the
FileStorage API mandates an AD per request.

Uses `clojure.java.data.builder/to-java` with `:limit` pre-coerced to
`Integer` to satisfy the SDK setter type under cloverage instrumentation.

Results are cached via `service.memo` keyed by compartment-id and
availability-domain — subsequent calls with the same params return
cached data unless `:refresh?` is set.
raw docstring

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

clj-oci.maintenance

OCI Instance Maintenance API wrapper.

Provides operations for managing instance maintenance events:

  • list-maintenance-events — paginated listing with filters
  • get-maintenance-event — single event by OCID
  • update-maintenance-event — reschedule or modify an event
  • get-maintenance-reboot — max reschedule date for an instance

Uses ComputeClient via clj-oci.clients. No caching — maintenance events are dynamic (state transitions) and always fetched fresh.

OCI Instance Maintenance API wrapper.

Provides operations for managing instance maintenance events:
- `list-maintenance-events` — paginated listing with filters
- `get-maintenance-event` — single event by OCID
- `update-maintenance-event` — reschedule or modify an event
- `get-maintenance-reboot` — max reschedule date for an instance

Uses `ComputeClient` via `clj-oci.clients`. No caching — maintenance
events are dynamic (state transitions) and always fetched fresh.
raw docstring

clj-oci.request

Builds OCI Java SDK request objects from nested Clojure maps.

oci-build is the public entry point. It accepts a target Java class, the corresponding schema from oci-doc, a Clojure params map, and an enum registry from enum-registry. It is intended to be called from clj-oci.oci/oci-request.

Error reporting uses breadcrumb paths so failures are easy to locate:

(oci-build RequestSummarizedUsagesRequest request-schema {:requestSummarizedUsagesDetails {:granularity :typo ...}} enum-reg) ;; => throws ex-info with: ;; {:path [:requestSummarizedUsagesDetails :granularity] ;; :expected {:type ...Granularity :enum-values [Hourly Daily ...]} ;; :got :typo}

Builds OCI Java SDK request objects from nested Clojure maps.

`oci-build` is the public entry point. It accepts a target Java class,
the corresponding schema from `oci-doc`, a Clojure params map, and an
enum registry from `enum-registry`. It is intended to be called from
`clj-oci.oci/oci-request`.

Error reporting uses breadcrumb paths so failures are easy to locate:

  (oci-build RequestSummarizedUsagesRequest
             request-schema
             {:requestSummarizedUsagesDetails
              {:granularity :typo ...}}
             enum-reg)
  ;; => throws ex-info with:
  ;;    {:path     [:requestSummarizedUsagesDetails :granularity]
  ;;     :expected {:type ...Granularity :enum-values [Hourly Daily ...]}
  ;;     :got      :typo}
raw docstring

clj-oci.tag.bulk

OCI Bulk Tag and Standard Tag Template API wrapper.

Provides operations for bulk tag management and standard templates:

  • bulk-delete-tags — delete multiple tag definitions (async)
  • bulk-edit-tags — add/update/remove tags on resources (async)
  • list-bulk-edit-tags-resource-types — metadata: which resource types support bulk edit
  • import-standard-tags — import Oracle standard tag templates (async)
  • list-standard-tag-namespaces — list available standard templates
  • get-standard-tag-template — get a specific standard template

Uses IdentityClient via clj-oci.clients. No caching — tags are dynamic and always fetched fresh.

OCI Bulk Tag and Standard Tag Template API wrapper.

Provides operations for bulk tag management and standard templates:
- `bulk-delete-tags` — delete multiple tag definitions (async)
- `bulk-edit-tags` — add/update/remove tags on resources (async)
- `list-bulk-edit-tags-resource-types` — metadata: which resource types support bulk edit
- `import-standard-tags` — import Oracle standard tag templates (async)
- `list-standard-tag-namespaces` — list available standard templates
- `get-standard-tag-template` — get a specific standard template

Uses `IdentityClient` via `clj-oci.clients`. No caching — tags are
dynamic and always fetched fresh.
raw docstring

clj-oci.tag.common

Shared helpers for OCI Tag API modules.

Lock detail builders and enum maps used by clj-oci.tag.namespaces and clj-oci.tag.defaults.

Shared helpers for OCI Tag API modules.

Lock detail builders and enum maps used by `clj-oci.tag.namespaces`
and `clj-oci.tag.defaults`.
raw docstring

clj-oci.tag.defaults

OCI Tag Default API wrapper.

Provides operations for managing tag defaults:

  • list-tag-defaults — paginated listing with filters
  • assemble-effective-tag-set — resolved defaults for a compartment hierarchy
  • get-tag-default — single default by OCID
  • create-tag-default — create a new default
  • update-tag-default — update value or required flag
  • delete-tag-default — delete a default
  • add-tag-default-lock / remove-tag-default-lock — resource locking

Uses IdentityClient via clj-oci.clients. No caching — tag defaults are dynamic and always fetched fresh.

OCI Tag Default API wrapper.

Provides operations for managing tag defaults:
- `list-tag-defaults` — paginated listing with filters
- `assemble-effective-tag-set` — resolved defaults for a compartment hierarchy
- `get-tag-default` — single default by OCID
- `create-tag-default` — create a new default
- `update-tag-default` — update value or required flag
- `delete-tag-default` — delete a default
- `add-tag-default-lock` / `remove-tag-default-lock` — resource locking

Uses `IdentityClient` via `clj-oci.clients`. No caching — tag defaults
are dynamic and always fetched fresh.
raw docstring

clj-oci.tag.definitions

OCI Tag Definition API wrapper.

Provides operations for managing tag definitions within namespaces:

  • list-tags — paginated listing within a namespace
  • list-cost-tracking-tags — paginated listing of cost-tracking tags
  • get-tag — single tag by namespace OCID + name
  • create-tag — create a new tag definition
  • update-tag — update description, retire, cost-tracking, validator
  • delete-tag — delete a tag definition (async, must retire first)

Uses IdentityClient via clj-oci.clients. No caching — tags are dynamic and always fetched fresh.

OCI Tag Definition API wrapper.

Provides operations for managing tag definitions within namespaces:
- `list-tags` — paginated listing within a namespace
- `list-cost-tracking-tags` — paginated listing of cost-tracking tags
- `get-tag` — single tag by namespace OCID + name
- `create-tag` — create a new tag definition
- `update-tag` — update description, retire, cost-tracking, validator
- `delete-tag` — delete a tag definition (async, must retire first)

Uses `IdentityClient` via `clj-oci.clients`. No caching — tags are
dynamic and always fetched fresh.
raw docstring

clj-oci.tag.namespaces

OCI Tag Namespace API wrapper.

Provides operations for managing tag namespaces:

  • list-tag-namespaces — paginated listing with filters
  • get-tag-namespace — single namespace by OCID
  • create-tag-namespace — create a new namespace
  • update-tag-namespace — update description, retire/reactivate
  • delete-tag-namespace — delete an empty namespace
  • cascade-delete-tag-namespace — delete namespace and all its tags (async)
  • change-tag-namespace-compartment — move namespace between compartments
  • add-tag-namespace-lock / remove-tag-namespace-lock — resource locking

Uses IdentityClient via clj-oci.clients. No caching — tags are dynamic and always fetched fresh.

OCI Tag Namespace API wrapper.

Provides operations for managing tag namespaces:
- `list-tag-namespaces` — paginated listing with filters
- `get-tag-namespace` — single namespace by OCID
- `create-tag-namespace` — create a new namespace
- `update-tag-namespace` — update description, retire/reactivate
- `delete-tag-namespace` — delete an empty namespace
- `cascade-delete-tag-namespace` — delete namespace and all its tags (async)
- `change-tag-namespace-compartment` — move namespace between compartments
- `add-tag-namespace-lock` / `remove-tag-namespace-lock` — resource locking

Uses `IdentityClient` via `clj-oci.clients`. No caching — tags are
dynamic and always fetched fresh.
raw docstring

clj-oci.tag.work-requests

OCI Tagging Work Request API wrapper.

Provides operations for tracking async tagging operations:

  • get-tagging-work-request — single work request by OCID
  • list-tagging-work-requests — paginated listing by compartment
  • list-tagging-work-request-errors — paginated errors for a work request
  • list-tagging-work-request-logs — paginated logs for a work request

Uses IdentityClient via clj-oci.clients. No caching — work requests are dynamic and always fetched fresh.

OCI Tagging Work Request API wrapper.

Provides operations for tracking async tagging operations:
- `get-tagging-work-request` — single work request by OCID
- `list-tagging-work-requests` — paginated listing by compartment
- `list-tagging-work-request-errors` — paginated errors for a work request
- `list-tagging-work-request-logs` — paginated logs for a work request

Uses `IdentityClient` via `clj-oci.clients`. No caching — work requests
are dynamic and always fetched fresh.
raw docstring

clj-oci.tenancy

Return the specified tenancy OCID from environment variables.

Return the specified tenancy OCID from environment variables.
raw docstring

clj-oci.usageapi2

OCI Usage API built on oci-build.

Where clj-oci.usageapi hand-rolls builders for each SDK type, this namespace uses the introspected schema (oci-doc) and oci-build to construct request objects from plain Clojure maps. Enum keywords, nested builders, and List<T> elements are all handled automatically.

OCI Usage API built on `oci-build`.

Where `clj-oci.usageapi` hand-rolls builders for each SDK type, this namespace
uses the introspected schema (`oci-doc`) and `oci-build` to construct request
objects from plain Clojure maps.  Enum keywords, nested builders, and
List<T> elements are all handled automatically.
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