homeassistant.components.upcloud.entity.UpCloudServerEntity Class Reference

Inheritance diagram for homeassistant.components.upcloud.entity.UpCloudServerEntity:

Collaboration diagram for homeassistant.components.upcloud.entity.UpCloudServerEntity:

Public Member Functions
None	__init__ (self, UpCloudDataUpdateCoordinator coordinator, str uuid)
bool	available (self)
DeviceInfo	device_info (self)
dict[str, Any]	extra_state_attributes (self)
str	icon (self)
bool	is_on (self)
str	name (self)
str	unique_id (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
Public Member Functions inherited from homeassistant.components.upcloud.coordinator.UpCloudDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, *upcloud_api.CloudManager cloud_manager, timedelta update_interval, str username)
None	async_update_config (self, ConfigEntry config_entry)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_config_entry_first_refresh (self)
Generator[Any]	async_contexts (self)
None	async_refresh (self)
None	async_register_shutdown (self)
None	async_request_refresh (self)
None	async_set_update_error (self, Exception err)
None	async_set_updated_data (self, _DataT data)
None	async_shutdown (self)
None	async_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)

Public Attributes
	uuid
Public Attributes inherited from homeassistant.components.upcloud.coordinator.UpCloudDataUpdateCoordinator
	cloud_manager
	update_interval
Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update
	config_entry
	data
	hass
	last_exception
	last_update_success
	logger
	name
	setup_method
	update_interval
	update_method

Private Member Functions
upcloud_api.Server	_server (self)

Detailed Description

Entity class for UpCloud servers.

Definition at line 31 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.upcloud.entity.UpCloudServerEntity.__init__	(		self,
		UpCloudDataUpdateCoordinator	coordinator,
		str	uuid
	)

Initialize the UpCloud server entity.

Definition at line 34 of file entity.py.

Member Function Documentation

_server()

upcloud_api.Server homeassistant.components.upcloud.entity.UpCloudServerEntity._server (   self )

private

Definition at line 44 of file entity.py.

available()

bool homeassistant.components.upcloud.entity.UpCloudServerEntity.available

(

self

)

Return True if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 74 of file entity.py.

device_info()

DeviceInfo homeassistant.components.upcloud.entity.UpCloudServerEntity.device_info

(

self

)

Return info for device registry.

Definition at line 96 of file entity.py.

extra_state_attributes()

dict[str, Any] homeassistant.components.upcloud.entity.UpCloudServerEntity.extra_state_attributes

(

self

)

Return the state attributes of the UpCloud server.

Definition at line 81 of file entity.py.

icon()

str homeassistant.components.upcloud.entity.UpCloudServerEntity.icon

(

self

)

Return the icon of this server.

Definition at line 61 of file entity.py.

is_on()

bool homeassistant.components.upcloud.entity.UpCloudServerEntity.is_on

(

self

)

Return true if the server is on.

Definition at line 66 of file entity.py.

name()

str homeassistant.components.upcloud.entity.UpCloudServerEntity.name

(

self

)

Return the name of the component.

Definition at line 53 of file entity.py.

unique_id()

str homeassistant.components.upcloud.entity.UpCloudServerEntity.unique_id

(

self

)

Return unique ID for the entity.

Definition at line 48 of file entity.py.

Member Data Documentation

uuid

homeassistant.components.upcloud.entity.UpCloudServerEntity.uuid

Definition at line 41 of file entity.py.

---

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

• core/homeassistant/components/upcloud/entity.py