NodeCandidate

sealed interface NodeCandidate

Known direct subclasses

`ActionCandidate`	Every ActionCandidate should implement this interface
`StarterCandidate`	Every StarterCandidate should implement this interface
`StateReaderCandidate`	Every StateReaderCandidate should implement this interface

Known indirect subclasses

`CommandCandidate`	Represents automation candidate node corresponding to a command.
`EventCandidate`	Represents automation candidate nodes corresponding to an event.
`TraitAttributesCandidate`	Represents automation candidate nodes corresponding to a trait's attributes.

The interface that every automation candidate should implement.

Summary

Public properties
`HasId`	`entity`
`Map<Field, FieldDetails>`	`fieldDetailsMap`
`Map<String, FieldDetails>`	`fields` This property is deprecated. Use fieldDetails instead
`TraitFactory<Trait>`	`trait`
`List<DeviceTypeFactory<DeviceType>>`	`types`
`List<UnsupportedCandidateReason>`	`unsupportedReasons`

val entity: HasId

val fieldDetailsMap: Map<Field, FieldDetails>

val fields: Map<String, FieldDetails>

val trait: TraitFactory<Trait>

val types: List<DeviceTypeFactory<DeviceType>>

val unsupportedReasons: List<UnsupportedCandidateReason>

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-03-13 UTC.

For devices
- Matter
  New IP-based smart home connectivity protocol that enables broad interoperability with many ecosystems
- Cloud-to-cloud
  Connect your cloud backend with the Smart Home API
- Find out which integration to build
  We’ll recommend an integration based on your device and needs
For apps, platforms & services
- Home APIs
  Access over 600M devices, hubs for Google Home and Matter infrastructure, and an automation engine powered by Google intelligence
Use cases
Business resources
Console
- Developer Console
- Support
- Stack Overflow
- Google Nest Community