homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection Class Reference

Inheritance diagram for homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection:

Collaboration diagram for homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection:

Public Member Functions
None	async_delete_item (self, str item_id)
str	async_get_preferred_item (self)
None	async_set_preferred_item (self, str item_id)
Public Member Functions inherited from homeassistant.components.assist_pipeline.pipeline.Pipeline
Pipeline	from_json (cls, dict[str, Any] data)
dict[str, Any]	to_json (self)

Private Member Functions
SerializedPipelineStorageCollection|None	_async_load_data (self)
Pipeline	_create_item (self, str item_id, dict data)
SerializedPipelineStorageCollection	_data_to_save (self)
Pipeline	_deserialize_item (self, dict data)
str	_get_suggested_id (self, dict info)
dict	_process_create_data (self, dict data)
dict	_serialize_item (self, str item_id, Pipeline item)
Pipeline	_update_data (self, Pipeline item, dict update_data)

Private Attributes
	_preferred_item

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.assist_pipeline.pipeline.Pipeline
	bool
	default_factory
	str

Detailed Description

Pipeline storage collection.

Definition at line 1581 of file pipeline.py.

Member Function Documentation

_async_load_data()

SerializedPipelineStorageCollection | None homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection._async_load_data (   self )

private

Load the data.

Definition at line 1588 of file pipeline.py.

_create_item()

Pipeline homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection._create_item (   self, str  item_id, dict  data  )

private

Create an item from validated config.

Definition at line 1614 of file pipeline.py.

_data_to_save()

SerializedPipelineStorageCollection homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection._data_to_save (   self )

private

Return JSON-compatible date for storing to file.

Definition at line 1646 of file pipeline.py.

_deserialize_item()

Pipeline homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection._deserialize_item (   self, dict  data  )

private

Create an item from its serialized representation.

Definition at line 1618 of file pipeline.py.

_get_suggested_id()

str homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection._get_suggested_id (   self, dict  info  )

private

Suggest an ID based on the config.

Definition at line 1605 of file pipeline.py.

_process_create_data()

dict homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection._process_create_data (   self, dict  data  )

private

Validate the config is valid.

Definition at line 1599 of file pipeline.py.

_serialize_item()

dict homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection._serialize_item (   self, str  item_id, Pipeline  item  )

private

Return the serialized representation of an item for storing.

Definition at line 1622 of file pipeline.py.

_update_data()

Pipeline homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection._update_data (   self, Pipeline  item, dict  update_data  )

private

Return a new updated item.

Definition at line 1609 of file pipeline.py.

async_delete_item()

None homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection.async_delete_item	(		self,
		str	item_id
	)

Delete item.

Definition at line 1626 of file pipeline.py.

async_get_preferred_item()

str homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection.async_get_preferred_item

(

self

)

Get the id of the preferred item.

Definition at line 1633 of file pipeline.py.

async_set_preferred_item()

None homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection.async_set_preferred_item	(		self,
		str	item_id
	)

Set the preferred pipeline.

Definition at line 1638 of file pipeline.py.

Member Data Documentation

_preferred_item

homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection._preferred_item

private

Definition at line 1592 of file pipeline.py.

---

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

• core/homeassistant/components/assist_pipeline/pipeline.py