# ironicclient.common.apiclient.base module

Base utilities to build API operation managers and objects on top of.

class ironicclient.common.apiclient.base.ManagerProtocol(*args, **kwargs)

  Bases: `Protocol`

  Minimal protocol for Resource’s manager dependency.

  client: Any

class ironicclient.common.apiclient.base.Resource(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)

  Bases: `object`

  Base class for OpenStack resources (tenant, user, etc.).

  This is pretty much just a bag for attributes.

  HUMAN_ID: bool = False
  NAME_ATTR: str = 'name'
  get() → None

    Support for lazy loading details.

    Some clients, such as novaclient have the option to lazy load the details, details which can be loaded with this function.

  property human_id: str | None

    Human-readable ID which can be used for bash completion.

  is_loaded() → bool
  set_loaded(val: bool) → None
  to_dict() → dict[str, Any]

this page last updated: 2026-07-16 03:09:15

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug