Liking cljdoc? Tell your friends :D

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

create-tagclj

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

Creates a new tag definition in a namespace.

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

details is a map: :name — unique name within namespace (required) :description — description (required) :freeform-tags — map of strings (optional) :defined-tags — map of maps (optional) :is-cost-tracking — boolean (optional) :validator — BaseTagDefinitionValidator instance (optional)

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

Creates a new tag definition in a namespace.

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

`details` is a map:
  :name             — unique name within namespace (required)
  :description      — description (required)
  :freeform-tags    — map of strings (optional)
  :defined-tags     — map of maps (optional)
  :is-cost-tracking — boolean (optional)
  :validator        — BaseTagDefinitionValidator instance (optional)

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

delete-tagclj

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

Deletes a tag definition (async). The tag must be retired first.

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

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

Deletes a tag definition (async). The tag must be retired first.

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

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

get-tagclj

(get-tag tag-namespace-id tag-name)

Fetches a single tag definition by namespace OCID and tag name.

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

Fetches a single tag definition by namespace OCID and tag name.

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

list-cost-tracking-tagsclj

(list-cost-tracking-tags compartment-id)
(list-cost-tracking-tags compartment-id opts)

Fetches all cost-tracking tags in compartment-id, paginating automatically.

Returns {:data {:items [tag-maps...]}} or {:error ...}. Unlike list-tags, returns full Tag objects (not summaries).

Options (all optional): :limit — page size, default 100

Fetches all cost-tracking tags in `compartment-id`, paginating automatically.

Returns {:data {:items [tag-maps...]}} or {:error ...}.
Unlike `list-tags`, returns full Tag objects (not summaries).

Options (all optional):
  :limit — page size, default 100
raw docstring

list-tagsclj

(list-tags tag-namespace-id)
(list-tags tag-namespace-id opts)

Fetches tag definitions in tag-namespace-id, paginating automatically.

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

Options (all optional): :lifecycle-state — keyword (:active :inactive :deleting :deleted) :limit — page size, default 100

Fetches tag definitions in `tag-namespace-id`, paginating automatically.

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

Options (all optional):
  :lifecycle-state — keyword (:active :inactive :deleting :deleted)
  :limit           — page size, default 100
raw docstring

update-tagclj

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

Updates a tag definition (description, retire, cost-tracking, validator).

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

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

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

Updates a tag definition (description, retire, cost-tracking, validator).

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

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

`opts` may include:
  :if-match         — etag for optimistic concurrency
  :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