Home Assistant Unofficial Reference 2024.12.1
Public Member Functions | Public Attributes | List of all members
homeassistant.components.blueprint.models.Blueprint Class Reference

Public Member Functions

None __init__ (self, dict[str, Any] data, *str|None path=None, str|None expected_domain=None, Callable[[Any], Any] schema)
 
dict[str, Any] inputs (self)
 
dict[str, Any] metadata (self)
 
str name (self)
 
None update_metadata (self, *str|None source_url=None)
 
list[str]|None validate (self)
 
str yaml (self)
 

Public Attributes

 data
 
 domain
 

Detailed Description

Blueprint of a configuration structure.

Definition at line 50 of file models.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.blueprint.models.Blueprint.__init__ (   self,
dict[str, Any]  data,
*str | None   path = None,
str | None   expected_domain = None,
Callable[[Any], Any]  schema 
) 
Initialize a blueprint.

Definition at line 53 of file models.py.

Member Function Documentation

◆ inputs()

dict[str, Any] homeassistant.components.blueprint.models.Blueprint.inputs (   self) 
Return flattened blueprint inputs.

Definition at line 98 of file models.py.

◆ metadata()

dict[str, Any] homeassistant.components.blueprint.models.Blueprint.metadata (   self) 
Return blueprint metadata.

Definition at line 109 of file models.py.

◆ name()

str homeassistant.components.blueprint.models.Blueprint.name (   self) 
Return blueprint name.

Definition at line 93 of file models.py.

◆ update_metadata()

None homeassistant.components.blueprint.models.Blueprint.update_metadata (   self,
*str | None   source_url = None 
) 
Update metadata.

Definition at line 113 of file models.py.

◆ validate()

list[str] | None homeassistant.components.blueprint.models.Blueprint.validate (   self) 
Test if the Home Assistant installation supports this blueprint.

Return list of errors if not valid.

Definition at line 123 of file models.py.

◆ yaml()

str homeassistant.components.blueprint.models.Blueprint.yaml (   self) 
Dump blueprint as YAML.

Definition at line 118 of file models.py.

Member Data Documentation

◆ data

homeassistant.components.blueprint.models.Blueprint.data

Definition at line 63 of file models.py.

◆ domain

homeassistant.components.blueprint.models.Blueprint.domain

Definition at line 80 of file models.py.

The documentation for this class was generated from the following file: