Struct google_api_proto::google::home::graph::v1::Device

pub struct Device {
    pub id: String,
    pub type: String,
    pub traits: Vec<String>,
    pub name: Option<DeviceNames>,
    pub will_report_state: bool,
    pub room_hint: String,
    pub structure_hint: String,
    pub device_info: Option<DeviceInfo>,
    pub attributes: Option<Struct>,
    pub custom_data: Option<Struct>,
    pub other_device_ids: Vec<AgentOtherDeviceId>,
    pub notification_supported_by_agent: bool,
}

Third-party device definition.

Fields

id: String

Third-party device ID.

type: String

Hardware type of the device. See device types.

traits: Vec<String>

Traits supported by the device. See device traits.

name: Option<DeviceNames>

Names given to this device by your smart home Action.

will_report_state: bool

Indicates whether your smart home Action will report state of this device to Google via [ReportStateAndNotification][google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification].

room_hint: String

Suggested name for the room where this device is installed. Google attempts to use this value during user setup.

structure_hint: String

Suggested name for the structure where this device is installed. Google attempts to use this value during user setup.

device_info: Option<DeviceInfo>

Device manufacturer, model, hardware version, and software version.

attributes: Option<Struct>

Attributes for the traits supported by the device.

custom_data: Option<Struct>

Custom device attributes stored in Home Graph and provided to your smart home Action in each QUERY and EXECUTE intent. Data in this object has a few constraints: No sensitive information, including but not limited to Personally Identifiable Information.

other_device_ids: Vec<AgentOtherDeviceId>

Alternate IDs associated with this device. This is used to identify cloud synced devices enabled for local fulfillment.

notification_supported_by_agent: bool

Indicates whether your smart home Action will report notifications to Google for this device via [ReportStateAndNotification][google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification].

If your smart home Action enables users to control device notifications, you should update this field and call [RequestSyncDevices][google.home.graph.v1.HomeGraphApiService.RequestSyncDevices].

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Device

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

Formats the value using the given formatter.

impl Default for Device

fn default() -> Self

Returns the “default value” for a type.

impl Message for Device

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Device

fn eq(&self, other: &Device) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Device