Skip to content

Latest commit

 

History

History
215 lines (127 loc) · 4.12 KB

reference.rst

File metadata and controls

215 lines (127 loc) · 4.12 KB

Reference

Objects returned when querying Hikaru itself

.. autoclass:: hikaru.CatalogEntry
   :members:

CatalogEntry is a namedtuple that is returned as list elements from the :meth:`find_by_name()<hikaru.HikaruBase.find_by_name>` method of HikaruBase.

.. autoclass:: hikaru.TypeWarning
   :members:

TypeWarning is a dataclass that is returned as list elements from the :meth:`get_type_warnings()<hikaru.HikaruBase.get_type_warnings>` method of HikaruBase.

.. autoclass:: hikaru.DiffDetail
   :members:


.. autoclass:: hikaru.DiffType

Hikaru modelling base classes

.. autoclass:: hikaru.HikaruBase
   :members:


.. autoclass:: hikaru.HikaruDocumentBase
   :members:


.. autoclass:: hikaru.crd.HikaruCRDDocumentMixin
   :members:

Hikaru Application classes

.. autoclass:: hikaru.app.Application

    .. automethod:: create
    .. automethod:: delete
    .. automethod:: diff
    .. automethod:: dup
    .. automethod:: find_by_name
    .. automethod:: find_uses_of_class
    .. automethod:: from_dict
    .. automethod:: from_json
    .. automethod:: from_yaml
    .. automethod:: get_clean_dict
    .. automethod:: get_empty_instance
    .. automethod:: get_json
    .. automethod:: get_type_warnings
    .. automethod:: get_yaml
    .. automethod:: merge
    .. automethod:: object_at_path
    .. automethod:: read
    .. automethod:: set_reporter
    .. automethod:: update


.. autoclass:: hikaru.app.Reporter
    :members:


.. autoclass:: hikaru.app.FieldInfo
    :members:


.. autoclass:: hikaru.meta.FieldMetadata

   .. automethod::  __init__


.. autoclass:: hikaru.Response
   :members:

Hikaru Watchers

.. autoclass:: hikaru.watch.WatchEvent
   :members:


.. autoclass:: hikaru.watch.Watcher
   :members:

   .. automethod:: __init__


.. autoclass:: hikaru.watch.MultiplexingWatcher
   :members:

   .. automethod:: __init__

Hikaru functions

.. autofunction:: hikaru.from_dict


.. autofunction:: hikaru.from_json


.. autofunction:: hikaru.get_clean_dict


.. autofunction:: hikaru.get_json


.. autofunction:: hikaru.get_processors


.. autofunction:: hikaru.get_python_source


.. autofunction:: hikaru.get_yaml


.. autofunction:: hikaru.load_full_yaml


.. autofunction:: hikaru.process_api_version


.. autofunction:: hikaru.get_default_release


.. autofunction:: hikaru.set_default_release


.. autofunction:: hikaru.set_global_default_release


.. autofunction:: hikaru.get_version_kind_class


.. autofunction:: hikaru.register_version_kind_class


.. autofunction:: hikaru.rollback_cm


.. autofunction:: hikaru.crd.get_crd_schema


.. autofunction:: hikaru.crd.register_crd_class


.. autofunction:: hikaru.model.defrel.get_default_installed_release


.. autofunction:: hikaru.app.get_label_selector_for_instance_id


.. autofunction:: hikaru.app.get_app_instance_label_key


.. autofunction:: hikaru.app.set_app_instance_label_key


.. autofunction:: hikaru.app.set_global_app_instance_label_key


.. autofunction:: hikaru.app.record_resource_metadata


.. autofunction:: hikaru.app.resource_name_matches_metadata