Device (HomeGraph API v1-rev20230707-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.homegraph.v1.model.Device

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Device
extends com.google.api.client.json.GenericJson
```
Third-party device definition.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the HomeGraph API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Device()

Constructors
Constructor and Description
`Device()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Device`	`clone()`
`Map<String,Object>`	`getAttributes()` Attributes for the traits supported by the device.
`Map<String,Object>`	`getCustomData()` Custom device attributes stored in Home Graph and provided to your smart home Action in each [QUERY](https://developers.home.google.com/cloud-to-cloud/intents/query) and [EXECUTE](https://developers.home.google.com/cloud-to-cloud/intents/execute) intent.
`DeviceInfo`	`getDeviceInfo()` Device manufacturer, model, hardware version, and software version.
`String`	`getId()` Third-party device ID.
`DeviceNames`	`getName()` Names given to this device by your smart home Action.
`Boolean`	`getNotificationSupportedByAgent()` Indicates whether your smart home Action will report notifications to Google for this device via ReportStateAndNotification.
`List<AgentOtherDeviceId>`	`getOtherDeviceIds()` Alternate IDs associated with this device.
`String`	`getRoomHint()` Suggested name for the room where this device is installed.
`String`	`getStructureHint()` Suggested name for the structure where this device is installed.
`List<String>`	`getTraits()` Traits supported by the device.
`String`	`getType()` Hardware type of the device.
`Boolean`	`getWillReportState()` Indicates whether your smart home Action will report state of this device to Google via ReportStateAndNotification.
`Device`	`set(String fieldName, Object value)`
`Device`	`setAttributes(Map<String,Object> attributes)` Attributes for the traits supported by the device.
`Device`	`setCustomData(Map<String,Object> customData)` Custom device attributes stored in Home Graph and provided to your smart home Action in each [QUERY](https://developers.home.google.com/cloud-to-cloud/intents/query) and [EXECUTE](https://developers.home.google.com/cloud-to-cloud/intents/execute) intent.
`Device`	`setDeviceInfo(DeviceInfo deviceInfo)` Device manufacturer, model, hardware version, and software version.
`Device`	`setId(String id)` Third-party device ID.
`Device`	`setName(DeviceNames name)` Names given to this device by your smart home Action.
`Device`	`setNotificationSupportedByAgent(Boolean notificationSupportedByAgent)` Indicates whether your smart home Action will report notifications to Google for this device via ReportStateAndNotification.
`Device`	`setOtherDeviceIds(List<AgentOtherDeviceId> otherDeviceIds)` Alternate IDs associated with this device.
`Device`	`setRoomHint(String roomHint)` Suggested name for the room where this device is installed.
`Device`	`setStructureHint(String structureHint)` Suggested name for the structure where this device is installed.
`Device`	`setTraits(List<String> traits)` Traits supported by the device.
`Device`	`setType(String type)` Hardware type of the device.
`Device`	`setWillReportState(Boolean willReportState)` Indicates whether your smart home Action will report state of this device to Google via ReportStateAndNotification.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Device
```
public Device()
```
- Method Detail
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Attributes for the traits supported by the device.
    
    Returns:
    
    value or null for none
  - setAttributes
```
public Device setAttributes(Map<String,Object> attributes)
```
    Attributes for the traits supported by the device.
    
    Parameters:
    
    attributes - attributes or null for none
  - getCustomData
```
public Map<String,Object> getCustomData()
```
    Custom device attributes stored in Home Graph and provided to your smart home Action in each [QUERY](https://developers.home.google.com/cloud-to-cloud/intents/query) and [EXECUTE](https://developers.home.google.com/cloud-to-cloud/intents/execute) intent. Data in this object has a few constraints: No sensitive information, including but not limited to Personally Identifiable Information.
    
    Returns:
    
    value or null for none
  - setCustomData
```
public Device setCustomData(Map<String,Object> customData)
```
    Custom device attributes stored in Home Graph and provided to your smart home Action in each [QUERY](https://developers.home.google.com/cloud-to-cloud/intents/query) and [EXECUTE](https://developers.home.google.com/cloud-to-cloud/intents/execute) intent. Data in this object has a few constraints: No sensitive information, including but not limited to Personally Identifiable Information.
    
    Parameters:
    
    customData - customData or null for none
  - getDeviceInfo
```
public DeviceInfo getDeviceInfo()
```
    Device manufacturer, model, hardware version, and software version.
    
    Returns:
    
    value or null for none
  - setDeviceInfo
```
public Device setDeviceInfo(DeviceInfo deviceInfo)
```
    Device manufacturer, model, hardware version, and software version.
    
    Parameters:
    
    deviceInfo - deviceInfo or null for none
  - getId
```
public String getId()
```
    Third-party device ID.
    
    Returns:
    
    value or null for none
  - setId
```
public Device setId(String id)
```
    Third-party device ID.
    
    Parameters:
    
    id - id or null for none
  - getName
```
public DeviceNames getName()
```
    Names given to this device by your smart home Action.
    
    Returns:
    
    value or null for none
  - setName
```
public Device setName(DeviceNames name)
```
    Names given to this device by your smart home Action.
    
    Parameters:
    
    name - name or null for none
  - getNotificationSupportedByAgent
```
public Boolean getNotificationSupportedByAgent()
```
    Indicates whether your smart home Action will report notifications to Google for this device via ReportStateAndNotification. If your smart home Action enables users to control device notifications, you should update this field and call RequestSyncDevices.
    
    Returns:
    
    value or null for none
  - setNotificationSupportedByAgent
```
public Device setNotificationSupportedByAgent(Boolean notificationSupportedByAgent)
```
    Indicates whether your smart home Action will report notifications to Google for this device via ReportStateAndNotification. If your smart home Action enables users to control device notifications, you should update this field and call RequestSyncDevices.
    
    Parameters:
    
    notificationSupportedByAgent - notificationSupportedByAgent or null for none
  - getOtherDeviceIds
```
public List<AgentOtherDeviceId> getOtherDeviceIds()
```
    Alternate IDs associated with this device. This is used to identify cloud synced devices enabled for [local fulfillment](https://developers.home.google.com/local-home/overview).
    
    Returns:
    
    value or null for none
  - setOtherDeviceIds
```
public Device setOtherDeviceIds(List<AgentOtherDeviceId> otherDeviceIds)
```
    Alternate IDs associated with this device. This is used to identify cloud synced devices enabled for [local fulfillment](https://developers.home.google.com/local-home/overview).
    
    Parameters:
    
    otherDeviceIds - otherDeviceIds or null for none
  - getRoomHint
```
public String getRoomHint()
```
    Suggested name for the room where this device is installed. Google attempts to use this value during user setup.
    
    Returns:
    
    value or null for none
  - setRoomHint
```
public Device setRoomHint(String roomHint)
```
    Suggested name for the room where this device is installed. Google attempts to use this value during user setup.
    
    Parameters:
    
    roomHint - roomHint or null for none
  - getStructureHint
```
public String getStructureHint()
```
    Suggested name for the structure where this device is installed. Google attempts to use this value during user setup.
    
    Returns:
    
    value or null for none
  - setStructureHint
```
public Device setStructureHint(String structureHint)
```
    Suggested name for the structure where this device is installed. Google attempts to use this value during user setup.
    
    Parameters:
    
    structureHint - structureHint or null for none
  - getTraits
```
public List<String> getTraits()
```
    Traits supported by the device. See [device traits](https://developers.home.google.com/cloud- to-cloud/traits).
    
    Returns:
    
    value or null for none
  - setTraits
```
public Device setTraits(List<String> traits)
```
    Traits supported by the device. See [device traits](https://developers.home.google.com/cloud- to-cloud/traits).
    
    Parameters:
    
    traits - traits or null for none
  - getType
```
public String getType()
```
    Hardware type of the device. See [device types](https://developers.home.google.com/cloud-to- cloud/guides).
    
    Returns:
    
    value or null for none
  - setType
```
public Device setType(String type)
```
    Hardware type of the device. See [device types](https://developers.home.google.com/cloud-to- cloud/guides).
    
    Parameters:
    
    type - type or null for none
  - getWillReportState
```
public Boolean getWillReportState()
```
    Indicates whether your smart home Action will report state of this device to Google via ReportStateAndNotification.
    
    Returns:
    
    value or null for none
  - setWillReportState
```
public Device setWillReportState(Boolean willReportState)
```
    Indicates whether your smart home Action will report state of this device to Google via ReportStateAndNotification.
    
    Parameters:
    
    willReportState - willReportState or null for none
  - set
```
public Device set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Device clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Device

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Device

Method Detail

getAttributes

setAttributes

getCustomData

setCustomData

getDeviceInfo

setDeviceInfo

getId

setId

getName

setName

getNotificationSupportedByAgent

setNotificationSupportedByAgent

getOtherDeviceIds

setOtherDeviceIds

getRoomHint

setRoomHint

getStructureHint

setStructureHint

getTraits

setTraits

getType

setType

getWillReportState

setWillReportState

set

clone