REST Resource: enterprises.structures
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Structure
Structure resource represents an instance of enterprise managed home or hotel room.
| JSON representation |
{
"name": string,
"traits": {
object
}
} |
| Fields |
name |
string
Output only. The resource name of the structure. For example: "enterprises/XYZ/structures/ABC".
|
traits |
object (Struct format)
Structure traits.
|
Methods |
|
|
Gets a structure managed by the enterprise. |
|
|
Lists structures managed by the enterprise. |
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 2024-08-07 UTC.
[null,null,["Last updated 2024-08-07 UTC."],[[["\u003cp\u003eStructure resource represents an enterprise-managed home or hotel room with a name and traits.\u003c/p\u003e\n"],["\u003cp\u003eStructures can be retrieved individually using the \u003ccode\u003eget\u003c/code\u003e method or listed for an enterprise via the \u003ccode\u003elist\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe resource is represented in JSON format with \u003ccode\u003ename\u003c/code\u003e and \u003ccode\u003etraits\u003c/code\u003e fields containing structure details.\u003c/p\u003e\n"]]],["The document defines a \"Structure\" resource, representing a managed home or hotel room. Its JSON representation includes a `name` (a unique identifier) and `traits` (structure-specific features). The resource provides two methods: `get`, to retrieve a specific structure by its identifier, and `list`, to retrieve a collection of all the structures managed by the enterprise. The traits of a structure is represented by a google.protobuf.Struct.\n"],null,["# REST Resource: enterprises.structures\n\n- [Resource: Structure](#Structure)\n - [JSON representation](#Structure.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Structure\n-------------------\n\nStructure resource represents an instance of enterprise managed home or hotel room.\n\n| JSON representation |\n|--------------------------------------------------|\n| ``` { \"name\": string, \"traits\": { object } } ``` |\n\n| Fields ||\n|----------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The resource name of the structure. For example: \"enterprises/XYZ/structures/ABC\". |\n| `traits` | `object (`[Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Struct)` format)` Structure traits. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------|---------------------------------------------|\n| ### [get](/nest/device-access/reference/rest/v1/enterprises.structures/get) | Gets a structure managed by the enterprise. |\n| ### [list](/nest/device-access/reference/rest/v1/enterprises.structures/list) | Lists structures managed by the enterprise. |"]]
