Liking cljdoc? Tell your friends :D

clj-oci.organizations.domain-governance

OCI Organizations API — DomainGovernance resource (Tenant Manager Control Plane).

A DomainGovernance is the governance/ONS-notification configuration attached to a claimed Domain. Five ops served by DomainGovernanceClient, all synchronous:

  • create-domain-governance — attach governance to a claimed Domain (200, returns DG)
  • get-domain-governance — fetch one DomainGovernance
  • list-domain-governances — list in a compartment (paginated, filterable)
  • update-domain-governance — update subscription email / governance flag / tags (200)
  • delete-domain-governance — remove governance from a Domain (204, no body)

list-domain-governances filters by domainId, domainGovernanceId, lifecycleState (shared 6-state enum), and name, plus standard sortBy/sortOrder/limit/page.

Region routing follows the standard pattern.

OCI Organizations API — DomainGovernance resource (Tenant Manager Control Plane).

A DomainGovernance is the governance/ONS-notification configuration
attached to a claimed Domain. Five ops served by `DomainGovernanceClient`,
all synchronous:

- `create-domain-governance` — attach governance to a claimed Domain (200, returns DG)
- `get-domain-governance`    — fetch one DomainGovernance
- `list-domain-governances`  — list in a compartment (paginated, filterable)
- `update-domain-governance` — update subscription email / governance flag / tags (200)
- `delete-domain-governance` — remove governance from a Domain (204, no body)

`list-domain-governances` filters by `domainId`, `domainGovernanceId`,
`lifecycleState` (shared 6-state enum), and `name`, plus standard
`sortBy`/`sortOrder`/`limit`/`page`.

Region routing follows the standard pattern.
raw docstring

create-domain-governanceclj

(create-domain-governance details)
(create-domain-governance details opts)

Attaches governance to a claimed Domain (sync, returns the new DomainGovernance).

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

details map: :compartment-id (required, tenancy OCID) :domain-id (required, OCID of the Domain to govern) :ons-topic-id (required, ONS topic OCID) :ons-subscription-id (required, ONS subscription OCID) :subscription-email (optional, notification email) :freeform-tags (optional, {string string}) :defined-tags (optional, {string {string Object}})

Options: :region — region-id or 3-letter code :opc-retry-token — idempotency token

Attaches governance to a claimed Domain (sync, returns the new
DomainGovernance).

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

`details` map:
  :compartment-id      (required, tenancy OCID)
  :domain-id           (required, OCID of the Domain to govern)
  :ons-topic-id        (required, ONS topic OCID)
  :ons-subscription-id (required, ONS subscription OCID)
  :subscription-email  (optional, notification email)
  :freeform-tags       (optional, {string string})
  :defined-tags        (optional, {string {string Object}})

Options:
  :region          — region-id or 3-letter code
  :opc-retry-token — idempotency token
raw docstring

delete-domain-governanceclj

(delete-domain-governance domain-governance-id)
(delete-domain-governance domain-governance-id opts)

Removes governance from a Domain (sync 204, no body).

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

Removes governance from a Domain (sync 204, no body).

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

get-domain-governanceclj

(get-domain-governance domain-governance-id)
(get-domain-governance domain-governance-id opts)

Fetches a single DomainGovernance by OCID.

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

Fetches a single DomainGovernance by OCID.

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

list-domain-governancesclj

(list-domain-governances compartment-id)
(list-domain-governances compartment-id opts)

Lists DomainGovernances in compartment-id, paginating automatically.

Returns {:data {:items [domain-governance-maps...]}} or {:error ...}.

Options: :region — region-id or 3-letter code :domain-id — exact-match Domain OCID :domain-governance-id — exact-match DomainGovernance OCID :lifecycle-state — keyword from the shared LifecycleState enum :name — exact-match filter :sort-by — :time-created or :display-name :sort-order — :asc or :desc :limit — page size (default 100; max 1000)

Lists DomainGovernances in `compartment-id`, paginating automatically.

Returns `{:data {:items [domain-governance-maps...]}}` or `{:error ...}`.

Options:
  :region               — region-id or 3-letter code
  :domain-id            — exact-match Domain OCID
  :domain-governance-id — exact-match DomainGovernance OCID
  :lifecycle-state      — keyword from the shared LifecycleState enum
  :name                 — exact-match filter
  :sort-by              — `:time-created` or `:display-name`
  :sort-order           — `:asc` or `:desc`
  :limit                — page size (default 100; max 1000)
raw docstring

update-domain-governanceclj

(update-domain-governance domain-governance-id details)
(update-domain-governance domain-governance-id details opts)

Updates a DomainGovernance (sync, returns the updated resource).

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

details map (all optional): :subscription-email — notification email :is-governance-enabled — boolean :freeform-tags — {string string} :defined-tags — {string {string Object}}

Options: :region — region-id or 3-letter code :if-match — etag for optimistic concurrency

Updates a DomainGovernance (sync, returns the updated resource).

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

`details` map (all optional):
  :subscription-email    — notification email
  :is-governance-enabled — boolean
  :freeform-tags         — `{string string}`
  :defined-tags          — `{string {string Object}}`

Options:
  :region   — region-id or 3-letter code
  :if-match — etag for optimistic concurrency
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