PluginCatalogEntry

Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

class PluginCatalogEntry(domain: str, name: str, purpose: str, required_params: Tuple[str, ...], optional_params: Tuple[str, ...], spec_example: str, create_example: str, params: Tuple[PluginParamInfo, ...] = ())

Bases: object

One catalog row derived from the constructor contract (not a hand-copied table).

Built-in components use constructor_signature(). Third-party plugins that register a legacy Pydantic params_model fall back to that schema for parameter metadata.

__init__(domain: str, name: str, purpose: str, required_params: Tuple[str, ...], optional_params: Tuple[str, ...], spec_example: str, create_example: str, params: Tuple[PluginParamInfo, ...] = ()) → None