blob: fa06233018986546b9b28ad998fb7ca0305443b9 [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="smartdevicemanagement_v1.html">Smart Device Management API</a> . <a href="smartdevicemanagement_v1.enterprises.html">enterprises</a> . <a href="smartdevicemanagement_v1.enterprises.structures.html">structures</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="smartdevicemanagement_v1.enterprises.structures.rooms.html">rooms()</a></code>
79</p>
80<p class="firstline">Returns the rooms Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Gets a structure managed by the enterprise.</p>
88<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080089 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090<p class="firstline">Lists structures managed by the enterprise.</p>
91<p class="toc_element">
92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
93<p class="firstline">Retrieves the next page of results.</p>
94<h3>Method Details</h3>
95<div class="method">
96 <code class="details" id="close">close()</code>
97 <pre>Close httplib2 connections.</pre>
98</div>
99
100<div class="method">
101 <code class="details" id="get">get(name, x__xgafv=None)</code>
102 <pre>Gets a structure managed by the enterprise.
103
104Args:
105 name: string, The name of the structure requested. For example: &quot;enterprises/XYZ/structures/ABC&quot;. (required)
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111Returns:
112 An object of the form:
113
114 { # Structure resource represents an instance of enterprise managed home or hotel room.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800115 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the structure. For example: &quot;enterprises/XYZ/structures/ABC&quot;.
116 &quot;traits&quot;: { # Structure traits.
117 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
118 },
119}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700120</div>
121
122<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800123 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700124 <pre>Lists structures managed by the enterprise.
125
126Args:
127 parent: string, The parent enterprise to list structures under. E.g. &quot;enterprises/XYZ&quot;. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700128 filter: string, Optional filter to list structures.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800129 pageSize: integer, Requested page size. Server may return fewer structures than requested. If unspecified, server will pick an appropriate default.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800130 pageToken: string, The token of the page to retrieve.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136Returns:
137 An object of the form:
138
139 { # Response message for SmartDeviceManagementService.ListStructures
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800140 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token to retrieve the next page of results. If this field is omitted, there are no subsequent pages.
141 &quot;structures&quot;: [ # The list of structures.
142 { # Structure resource represents an instance of enterprise managed home or hotel room.
143 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the structure. For example: &quot;enterprises/XYZ/structures/ABC&quot;.
144 &quot;traits&quot;: { # Structure traits.
145 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700146 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800147 },
148 ],
149}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700150</div>
151
152<div class="method">
153 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
154 <pre>Retrieves the next page of results.
155
156Args:
157 previous_request: The request for the previous page. (required)
158 previous_response: The response from the request for the previous page. (required)
159
160Returns:
161 A request object that you can call &#x27;execute()&#x27; on to request the next
162 page. Returns None if there are no more items in the collection.
163 </pre>
164</div>
165
166</body></html>