1<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.devices.html">devices</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#executeCommand">executeCommand(name, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Executes a command to device managed by the enterprise.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets a device managed by the enterprise.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists devices managed by the enterprise.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="executeCommand">executeCommand(name, body=None, x__xgafv=None)</code> 100 <pre>Executes a command to device managed by the enterprise. 101 102Args: 103 name: string, The name of the device requested. For example: "enterprises/XYZ/devices/123" (required) 104 body: object, The request body. 105 The object takes the form of: 106 107{ # Request message for SmartDeviceManagementService.ExecuteDeviceCommand 108 "command": "A String", # The command name to execute, represented by the fully qualified protobuf message name. 109 "params": { # The command message to execute, represented as a Struct. 110 "a_key": "", # Properties of the object. 111 }, 112} 113 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # Response message for SmartDeviceManagementService.ExecuteDeviceCommand 123 "results": { # The results of executing the command. 124 "a_key": "", # Properties of the object. 125 }, 126}</pre> 127</div> 128 129<div class="method"> 130 <code class="details" id="get">get(name, x__xgafv=None)</code> 131 <pre>Gets a device managed by the enterprise. 132 133Args: 134 name: string, The name of the device requested. For example: "enterprises/XYZ/devices/123" (required) 135 x__xgafv: string, V1 error format. 136 Allowed values 137 1 - v1 error format 138 2 - v2 error format 139 140Returns: 141 An object of the form: 142 143 { # Device resource represents an instance of enterprise managed device in the property. 144 "name": "A String", # Required. The resource name of the device. For example: "enterprises/XYZ/devices/123". 145 "parentRelations": [ # Assignee details of the device. 146 { # Represents device relationships, for instance, structure/room to which the device is assigned to. 147 "displayName": "A String", # Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to. 148 "parent": "A String", # Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: "enterprises/XYZ/structures/ABC" or "enterprises/XYZ/structures/ABC/rooms/123" 149 }, 150 ], 151 "traits": { # Output only. Device traits. 152 "a_key": "", # Properties of the object. 153 }, 154 "type": "A String", # Output only. Type of the device for general display purposes. For example: "THERMOSTAT". The device type should not be used to deduce or infer functionality of the actual device it is assigned to. Instead, use the returned traits for the device. 155}</pre> 156</div> 157 158<div class="method"> 159 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 160 <pre>Lists devices managed by the enterprise. 161 162Args: 163 parent: string, The parent enterprise to list devices under. E.g. "enterprises/XYZ". (required) 164 filter: string, Optional filter to list devices. Filters can be done on: Device custom name (substring match): 'customName=wing' 165 pageSize: integer, Optional requested page size. Server may return fewer devices than requested. If unspecified, server will pick an appropriate default. 166 pageToken: string, Optional token of the page to retrieve. 167 x__xgafv: string, V1 error format. 168 Allowed values 169 1 - v1 error format 170 2 - v2 error format 171 172Returns: 173 An object of the form: 174 175 { # Response message for SmartDeviceManagementService.ListDevices 176 "devices": [ # The list of devices. 177 { # Device resource represents an instance of enterprise managed device in the property. 178 "name": "A String", # Required. The resource name of the device. For example: "enterprises/XYZ/devices/123". 179 "parentRelations": [ # Assignee details of the device. 180 { # Represents device relationships, for instance, structure/room to which the device is assigned to. 181 "displayName": "A String", # Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to. 182 "parent": "A String", # Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: "enterprises/XYZ/structures/ABC" or "enterprises/XYZ/structures/ABC/rooms/123" 183 }, 184 ], 185 "traits": { # Output only. Device traits. 186 "a_key": "", # Properties of the object. 187 }, 188 "type": "A String", # Output only. Type of the device for general display purposes. For example: "THERMOSTAT". The device type should not be used to deduce or infer functionality of the actual device it is assigned to. Instead, use the returned traits for the device. 189 }, 190 ], 191 "nextPageToken": "A String", # The pagination token to retrieve the next page of results. 192}</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 197 <pre>Retrieves the next page of results. 198 199Args: 200 previous_request: The request for the previous page. (required) 201 previous_response: The response from the request for the previous page. (required) 202 203Returns: 204 A request object that you can call 'execute()' on to request the next 205 page. Returns None if there are no more items in the collection. 206 </pre> 207</div> 208 209</body></html>