Liking cljdoc? Tell your friends :D

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

add-tag-namespace-lockclj

(add-tag-namespace-lock namespace-id lock-details)
(add-tag-namespace-lock namespace-id lock-details opts)

Adds a resource lock to a tag namespace.

Returns {:data {...}} or {:error ...}.

lock-details is a map: :type — keyword (:full or :delete) or Java constant (required) :related-resource-id — OCID of related resource (optional) :message — lock message (optional)

opts may include: :if-match — etag for optimistic concurrency :opc-retry-token — idempotency token

Adds a resource lock to a tag namespace.

Returns {:data {...}} or {:error ...}.

`lock-details` is a map:
  :type                — keyword (:full or :delete) or Java constant (required)
  :related-resource-id — OCID of related resource (optional)
  :message             — lock message (optional)

`opts` may include:
  :if-match        — etag for optimistic concurrency
  :opc-retry-token — idempotency token
raw docstring

cascade-delete-tag-namespaceclj

(cascade-delete-tag-namespace namespace-id)
(cascade-delete-tag-namespace namespace-id opts)

Deletes a tag namespace and all its tag definitions (async).

The namespace must be retired first (see update-tag-namespace). Returns {:data {:opcWorkRequestId "..."}} or {:error ...}.

opts may include: :if-match — etag for optimistic concurrency :opc-retry-token — idempotency token :is-lock-override — boolean, override locks

Deletes a tag namespace and all its tag definitions (async).

The namespace must be retired first (see `update-tag-namespace`).
Returns {:data {:opcWorkRequestId "..."}} or {:error ...}.

`opts` may include:
  :if-match         — etag for optimistic concurrency
  :opc-retry-token  — idempotency token
  :is-lock-override — boolean, override locks
raw docstring

change-tag-namespace-compartmentclj

(change-tag-namespace-compartment namespace-id target-compartment-id)
(change-tag-namespace-compartment namespace-id target-compartment-id opts)

Moves a tag namespace (and all its tags) to a different compartment.

Returns {:data {...}} or {:error ...}.

opts may include: :opc-retry-token — idempotency token :is-lock-override — boolean, override locks

Moves a tag namespace (and all its tags) to a different compartment.

Returns {:data {...}} or {:error ...}.

`opts` may include:
  :opc-retry-token  — idempotency token
  :is-lock-override — boolean, override locks
raw docstring

create-tag-namespaceclj

(create-tag-namespace details)
(create-tag-namespace details opts)

Creates a new tag namespace.

Returns {:data {...}} or {:error ...}.

details is a map: :compartment-id — OCID of the compartment (required) :name — unique name within tenancy (required) :description — description (required) :freeform-tags — map of strings (optional) :defined-tags — map of maps (optional) :locks — list of lock details (optional)

opts may include: :opc-retry-token — idempotency token

Creates a new tag namespace.

Returns {:data {...}} or {:error ...}.

`details` is a map:
  :compartment-id — OCID of the compartment (required)
  :name           — unique name within tenancy (required)
  :description    — description (required)
  :freeform-tags  — map of strings (optional)
  :defined-tags   — map of maps (optional)
  :locks          — list of lock details (optional)

`opts` may include:
  :opc-retry-token — idempotency token
raw docstring

delete-tag-namespaceclj

(delete-tag-namespace namespace-id)
(delete-tag-namespace namespace-id opts)

Deletes an empty tag namespace. Use cascade-delete-tag-namespace for non-empty namespaces.

Returns {:data {...}} or {:error ...}.

opts may include: :if-match — etag for optimistic concurrency :is-lock-override — boolean, override locks

Deletes an empty tag namespace. Use `cascade-delete-tag-namespace`
for non-empty namespaces.

Returns {:data {...}} or {:error ...}.

`opts` may include:
  :if-match        — etag for optimistic concurrency
  :is-lock-override — boolean, override locks
raw docstring

get-tag-namespaceclj

(get-tag-namespace namespace-id)

Fetches a single tag namespace by its OCID.

Returns {:data {...}} or {:error ...}.

Fetches a single tag namespace by its OCID.

Returns {:data {...}} or {:error ...}.
raw docstring

list-tag-namespacesclj

(list-tag-namespaces compartment-id)
(list-tag-namespaces compartment-id opts)

Fetches tag namespaces in compartment-id, paginating automatically.

Returns {:data {:items [namespace-summary-maps...]}} or {:error ...}.

Options (all optional): :lifecycle-state — keyword (:active :inactive :deleting :deleted) :include-subcompartments — boolean, recurse into child compartments :limit — page size, default 100

Fetches tag namespaces in `compartment-id`, paginating automatically.

Returns {:data {:items [namespace-summary-maps...]}} or {:error ...}.

Options (all optional):
  :lifecycle-state         — keyword (:active :inactive :deleting :deleted)
  :include-subcompartments — boolean, recurse into child compartments
  :limit                   — page size, default 100
raw docstring

remove-tag-namespace-lockclj

(remove-tag-namespace-lock namespace-id lock-details)
(remove-tag-namespace-lock namespace-id lock-details opts)

Removes a resource lock from a tag namespace.

Returns {:data {...}} or {:error ...}.

lock-details is a map: :type — keyword (:full or :delete) or Java constant (required)

opts may include: :if-match — etag for optimistic concurrency :opc-retry-token — idempotency token

Removes a resource lock from a tag namespace.

Returns {:data {...}} or {:error ...}.

`lock-details` is a map:
  :type — keyword (:full or :delete) or Java constant (required)

`opts` may include:
  :if-match        — etag for optimistic concurrency
  :opc-retry-token — idempotency token
raw docstring

update-tag-namespaceclj

(update-tag-namespace namespace-id details)
(update-tag-namespace namespace-id details opts)

Updates a tag namespace (description, retire/reactivate, tags).

Returns {:data {...}} or {:error ...}.

details is a map (all optional): :description — new description :is-retired — boolean (retire or reactivate) :freeform-tags — map of strings :defined-tags — map of maps

opts may include: :is-lock-override — boolean, override locks

Updates a tag namespace (description, retire/reactivate, tags).

Returns {:data {...}} or {:error ...}.

`details` is a map (all optional):
  :description   — new description
  :is-retired    — boolean (retire or reactivate)
  :freeform-tags — map of strings
  :defined-tags  — map of maps

`opts` may include:
  :is-lock-override — boolean, override locks
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