Liking cljdoc? Tell your friends :D

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

add-tag-default-lockclj

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

Adds a resource lock to a tag default.

Returns {:data {:etag "..." ...}} 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 default.

Returns {:data {:etag "..." ...}} 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

assemble-effective-tag-setclj

(assemble-effective-tag-set compartment-id)
(assemble-effective-tag-set compartment-id opts)

Assembles the effective tag defaults for a compartment, walking the hierarchy up to the root. Child compartment defaults do not override parent defaults.

Note: the SDK request has no page/limit support — returns all results in one call via http-request.

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

opts may include: :lifecycle-state — keyword (:active)

Assembles the effective tag defaults for a compartment, walking the hierarchy
up to the root. Child compartment defaults do not override parent defaults.

Note: the SDK request has no page/limit support — returns all results in
one call via `http-request`.

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

`opts` may include:
  :lifecycle-state — keyword (:active)
raw docstring

create-tag-defaultclj

(create-tag-default details)
(create-tag-default details opts)

Creates a new tag default.

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

details is a map: :compartment-id — OCID of compartment (required) :tag-definition-id — OCID of tag definition (required) :value — default value (required) :is-required — boolean (optional) :locks — list of lock details (optional)

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

Creates a new tag default.

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

`details` is a map:
  :compartment-id    — OCID of compartment (required)
  :tag-definition-id — OCID of tag definition (required)
  :value             — default value (required)
  :is-required       — boolean (optional)
  :locks             — list of lock details (optional)

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

delete-tag-defaultclj

(delete-tag-default tag-default-id)
(delete-tag-default tag-default-id opts)

Deletes a tag default.

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

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

Deletes a tag default.

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

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

get-tag-defaultclj

(get-tag-default tag-default-id)

Fetches a single tag default by its OCID.

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

Fetches a single tag default by its OCID.

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

list-tag-defaultsclj

(list-tag-defaults opts)

Fetches tag defaults, paginating automatically.

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

Options (all optional): :compartment-id — OCID of compartment (optional, unlike most list ops) :id — filter by tag default OCID :tag-definition-id — filter by tag definition OCID :lifecycle-state — keyword (:active) :limit — page size, default 100

Fetches tag defaults, paginating automatically.

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

Options (all optional):
  :compartment-id    — OCID of compartment (optional, unlike most list ops)
  :id                — filter by tag default OCID
  :tag-definition-id — filter by tag definition OCID
  :lifecycle-state   — keyword (:active)
  :limit             — page size, default 100
raw docstring

remove-tag-default-lockclj

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

Removes a resource lock from a tag default.

Returns {:data {:etag "..." ...}} 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 default.

Returns {:data {:etag "..." ...}} 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-defaultclj

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

Updates a tag default (value, required flag).

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

details is a map (all optional): :value — new default value :is-required — boolean

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

Updates a tag default (value, required flag).

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

`details` is a map (all optional):
  :value       — new default value
  :is-required — boolean

`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