Liking cljdoc? Tell your friends :D

clj-oci.organizations.links

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

A Link is the parent↔child tenancy relationship inside an organization. Three ops served by LinkClient:

  • get-link — fetch one Link
  • list-links — list links (paginated, filterable)
  • delete-link — start the link termination workflow (async, returns workReqId)

list-links filters by parent tenancy, child tenancy, lifecycle state, and sort order (no sort-by on this op).

Region routing follows the standard pattern: (:region opts) > link OCID's region segment > singleton default.

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

A Link is the parent↔child tenancy relationship inside an organization.
Three ops served by `LinkClient`:

- `get-link`     — fetch one Link
- `list-links`   — list links (paginated, filterable)
- `delete-link`  — start the link termination workflow (async, returns workReqId)

`list-links` filters by parent tenancy, child tenancy, lifecycle state, and
sort order (no `sort-by` on this op).

Region routing follows the standard pattern: `(:region opts)` >
link OCID's region segment > singleton default.
raw docstring

(delete-link link-id)
(delete-link link-id opts)

Starts the link termination workflow (async).

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

Starts the link termination workflow (async).

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

(get-link link-id)
(get-link link-id opts)

Fetches a single Link by OCID.

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

Fetches a single Link by OCID.

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

(list-links opts)

Lists Links, paginating automatically. Requires at least one of :parent-tenancy-id or :child-tenancy-id — OCI's ListLinks endpoint rejects an unscoped listing with 404 NotAuthorizedOrNotFound.

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

Options: :parent-tenancy-id — required unless :child-tenancy-id is set :child-tenancy-id — required unless :parent-tenancy-id is set :region — region-id or 3-letter code :lifecycle-state — keyword (:creating, :active, :inactive, :updating, :failed, :terminated) or Java constant :sort-order — :asc or :desc :limit — page size (default 100; max 1000)

Lists Links, paginating automatically. Requires at least one of
`:parent-tenancy-id` or `:child-tenancy-id` — OCI's ListLinks endpoint
rejects an unscoped listing with 404 NotAuthorizedOrNotFound.

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

Options:
  :parent-tenancy-id — required unless `:child-tenancy-id` is set
  :child-tenancy-id  — required unless `:parent-tenancy-id` is set
  :region            — region-id or 3-letter code
  :lifecycle-state   — keyword (`:creating`, `:active`, `:inactive`,
                       `:updating`, `:failed`, `:terminated`) or Java constant
  :sort-order        — `:asc` or `:desc`
  :limit             — page size (default 100; max 1000)
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