Struct Entity 

pub struct Entity {
    pub device_id: String,
    pub entity_type: EntityType,
    pub external_id: Option<String>,
    pub id: String,
    pub metadata: Option<HashMap>,
    pub name: Option<String>,
    pub zone_id: Option<String>,
}

The actual controllable “button” or “sensor”.

Examples: Relay 1, Temp Sensor, Light Switch.

JSON schema

{
 "description": "The actual controllable \"button\" or \"sensor\".\n\nExamples: Relay 1, Temp Sensor, Light Switch.",
 "type": "object",
 "required": [
   "device_id",
   "entity_type",
   "id"
 ],
 "properties": {
   "device_id": {
     "description": "Parent device ID.",
     "type": "string"
   },
   "entity_type": {
     "$ref": "#/components/schemas/EntityType"
   },
   "external_id": {
     "description": "External ID from the integration.",
     "type": [
       "string",
       "null"
     ]
   },
   "id": {
     "description": "Unique identifier (ULID).",
     "type": "string"
   },
   "metadata": {
     "oneOf": [
       {
         "type": "null"
       },
       {
         "oneOf": [
           {
             "$ref": "#/components/schemas/HashMap"
           }
         ]
       }
     ]
   },
   "name": {
     "description": "Optional friendly name for the entity.",
     "type": [
       "string",
       "null"
     ]
   },
   "zone_id": {
     "description": "Optional zone this entity belongs to.",
     "type": [
       "string",
       "null"
     ]
   }
 }
}

Fields

device_id: String

Parent device ID.

entity_type: EntityType

external_id: Option<String>

External ID from the integration.

id: String

Unique identifier (ULID).

metadata: Option<HashMap>

name: Option<String>

Optional friendly name for the entity.

zone_id: Option<String>

Optional zone this entity belongs to.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Entity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Entity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Entity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.