| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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="chromemanagement_v1.html">Chrome Management API</a> . <a href="chromemanagement_v1.customers.html">customers</a> . <a href="chromemanagement_v1.customers.telemetry.html">telemetry</a> . <a href="chromemanagement_v1.customers.telemetry.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="#list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">List all telemetry devices.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="close">close()</code> |
| 89 | <pre>Close httplib2 connections.</pre> |
| 90 | </div> |
| 91 | |
| 92 | <div class="method"> |
| 93 | <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code> |
| 94 | <pre>List all telemetry devices. |
| 95 | |
| 96 | Args: |
| 97 | parent: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) |
| 98 | filter: string, Optional. Only include resources that match the filter. Supported filter fields: - org_unit_id - serial_number |
| 99 | pageSize: integer, Maximum number of results to return. Maximum and default are 100. |
| 100 | pageToken: string, Token to specify next page in the list. |
| 101 | readMask: string, Required. Read mask to specify which fields to return. |
| 102 | x__xgafv: string, V1 error format. |
| 103 | Allowed values |
| 104 | 1 - v1 error format |
| 105 | 2 - v2 error format |
| 106 | |
| 107 | Returns: |
| 108 | An object of the form: |
| 109 | |
| 110 | { |
| 111 | "devices": [ # Telemetry devices returned in the response. |
| 112 | { # Telemetry data collected from a managed device. |
| 113 | "batteryInfo": [ # Output only. Information on battery specs for the device. |
| 114 | { # Battery info |
| 115 | "designCapacity": "A String", # Output only. Design capacity (mAmpere-hours). |
| 116 | "designMinVoltage": 42, # Output only. Designed minimum output voltage (mV) |
| 117 | "manufactureDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Output only. The date the battery was manufactured. |
| 118 | "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 119 | "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 120 | "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 121 | }, |
| 122 | "manufacturer": "A String", # Output only. Battery manufacturer. |
| 123 | "serialNumber": "A String", # Output only. Battery serial number. |
| 124 | "technology": "A String", # Output only. Technology of the battery. Example: Li-ion |
| 125 | }, |
| 126 | ], |
| 127 | "batteryStatusReport": [ # Output only. Battery reports collected periodically. |
| 128 | { # Status data for battery. |
| 129 | "batteryHealth": "A String", # Output only. Battery health. |
| 130 | "cycleCount": 42, # Output only. Cycle count. |
| 131 | "fullChargeCapacity": "A String", # Output only. Full charge capacity (mAmpere-hours). |
| 132 | "reportTime": "A String", # Output only. Timestamp of when the sample was collected on device |
| 133 | "sample": [ # Output only. Sampling data for the battery. |
| 134 | { # Sampling data for battery. |
| 135 | "chargeRate": 42, # Output only. Battery charge percentage. |
| 136 | "current": "A String", # Output only. Battery current (mA). |
| 137 | "dischargeRate": 42, # Output only. The battery discharge rate measured in mW. Positive if the battery is being discharged, negative if it's being charged. |
| 138 | "remainingCapacity": "A String", # Output only. Battery remaining capacity (mAmpere-hours). |
| 139 | "reportTime": "A String", # Output only. Timestamp of when the sample was collected on device |
| 140 | "status": "A String", # Output only. Battery status read from sysfs. Example: Discharging |
| 141 | "temperature": 42, # Output only. Temperature in Celsius degrees. |
| 142 | "voltage": "A String", # Output only. Battery voltage (millivolt). |
| 143 | }, |
| 144 | ], |
| 145 | "serialNumber": "A String", # Output only. Battery serial number. |
| 146 | }, |
| 147 | ], |
| 148 | "cpuInfo": [ # Output only. Information regarding CPU specs for the device. |
| 149 | { # CPU specs for a CPU. |
| 150 | "architecture": "A String", # Output only. The CPU architecture. |
| 151 | "maxClockSpeed": 42, # Output only. The max CPU clock speed in kHz. |
| 152 | "model": "A String", # Output only. The CPU model name. Example: Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz |
| 153 | }, |
| 154 | ], |
| 155 | "cpuStatusReport": [ # Output only. CPU status reports collected periodically. |
| 156 | { # Contains samples of the cpu status reports. |
| 157 | "cpuTemperatureInfo": [ # Output only. CPU temperature sample info per CPU core in Celsius |
| 158 | { # CPU temperature of a device. Sampled per CPU core in Celsius |
| 159 | "label": "A String", # Output only. CPU label. Example: Core 0 |
| 160 | "temperatureCelsius": 42, # Output only. CPU temperature in Celsius. |
| 161 | }, |
| 162 | ], |
| 163 | "cpuUtilizationPct": 42, # Output only. Sample of CPU utilization (0-100 percent). |
| 164 | "reportTime": "A String", # Output only. The timestamp in milliseconds representing time at which this report was sampled. |
| 165 | "sampleFrequency": "A String", # Output only. Frequency the report is sampled. |
| 166 | }, |
| 167 | ], |
| 168 | "customer": "A String", # Output only. Google Workspace Customer whose enterprise enrolled the device. |
| 169 | "deviceId": "A String", # Output only. The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the Chrome OS Devices tab |
| 170 | "graphicsInfo": { # Information of the graphics subsystem. # Output only. Contains information regarding Graphic peripherals for the device. |
| 171 | "adapterInfo": { # Information of a graphics adapter (GPU). # Output only. Information about the graphics adapter (GPU). |
| 172 | "adapter": "A String", # Output only. Adapter name. Example: Mesa DRI Intel(R) UHD Graphics 620 (Kabylake GT2). |
| 173 | "deviceId": "A String", # Output only. Represents the graphics card device id. |
| 174 | "driverVersion": "A String", # Output only. Version of the GPU driver. |
| 175 | }, |
| 176 | }, |
| 177 | "graphicsStatusReport": [ # Output only. Graphics reports collected periodically. |
| 178 | { # Information of the graphics subsystem. |
| 179 | "displays": [ # Output only. Information about the displays for the device. |
| 180 | { # Information for a display. |
| 181 | "deviceId": "A String", # Output only. Represents the graphics card device id. |
| 182 | "isInternal": True or False, # Output only. Indicates if display is internal or not. |
| 183 | "refreshRate": 42, # Output only. Refresh rate in Hz. |
| 184 | "resolutionHeight": 42, # Output only. Resolution height in pixels. |
| 185 | "resolutionWidth": 42, # Output only. Resolution width in pixels. |
| 186 | }, |
| 187 | ], |
| 188 | "reportTime": "A String", # Output only. Time at which the graphics data was reported. |
| 189 | }, |
| 190 | ], |
| 191 | "memoryInfo": { # Memory information of a device. # Output only. Information regarding memory specs for the device. |
| 192 | "availableRamBytes": "A String", # Output only. Amount of available RAM in bytes. |
| 193 | "totalRamBytes": "A String", # Output only. Total RAM in bytes. |
| 194 | }, |
| 195 | "memoryStatusReport": [ # Output only. Memory status reports collected periodically. |
| 196 | { # Contains samples of memory status reports. |
| 197 | "pageFaults": 42, # Output only. Number of page faults during this collection |
| 198 | "reportTime": "A String", # Output only. The timestamp in milliseconds representing time at which this report was sampled. |
| 199 | "sampleFrequency": "A String", # Output only. Frequency the report is sampled. |
| 200 | "systemRamFreeBytes": "A String", # Output only. Amount of free RAM in bytes (unreliable due to Garbage Collection). |
| 201 | }, |
| 202 | ], |
| 203 | "name": "A String", # Output only. Resource name of the device. |
| 204 | "networkStatusReport": [ # Output only. Network specs collected periodically. |
| 205 | { # State of visible/configured networks. |
| 206 | "gatewayIpAddress": "A String", # Output only. Gateway IP address. |
| 207 | "lanIpAddress": "A String", # Output only. LAN IP address. |
| 208 | "reportTime": "A String", # Output only. Time at which the network state was reported. |
| 209 | "sampleFrequency": "A String", # Output only. Frequency the report is sampled. |
| 210 | "signalStrengthDbm": 42, # Output only. Signal strength for wireless networks measured in decibels. |
| 211 | }, |
| 212 | ], |
| 213 | "orgUnitId": "A String", # Output only. Organization unit ID of the device. |
| 214 | "osUpdateStatus": [ # Output only. Contains relevant information regarding ChromeOS update status. |
| 215 | { # Contains information regarding the current OS update status. |
| 216 | "lastRebootTime": "A String", # Output only. Timestamp of the last reboot. |
| 217 | "lastUpdateCheckTime": "A String", # Output only. Timestamp of the last update check. |
| 218 | "lastUpdateTime": "A String", # Output only. Timestamp of the last successful update. |
| 219 | "newPlatformVersion": "A String", # Output only. New platform version of the os image being downloaded and applied. It is only set when update status is OS_IMAGE_DOWNLOAD_IN_PROGRESS or OS_UPDATE_NEED_REBOOT. Note this could be a dummy "0.0.0.0" for OS_UPDATE_NEED_REBOOT status for some edge cases, e.g. update engine is restarted without a reboot. |
| 220 | "newRequestedPlatformVersion": "A String", # Output only. New requested platform version from the pending updated kiosk app. |
| 221 | "updateState": "A String", # Output only. Current state of the os update. |
| 222 | }, |
| 223 | ], |
| 224 | "serialNumber": "A String", # Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the Chrome OS Devices tab. |
| 225 | "storageInfo": { # Status data for storage. # Output only. Information of storage specs for the device. |
| 226 | "availableDiskBytes": "A String", # The available space for user data storage in the device in bytes. |
| 227 | "totalDiskBytes": "A String", # The total space for user data storage in the device in bytes. |
| 228 | "volume": [ # Information for disk volumes |
| 229 | { # Information for disk volumes |
| 230 | "storageFreeBytes": "A String", # Free storage space in bytes. |
| 231 | "storageTotalBytes": "A String", # Total storage space in bytes. |
| 232 | "volumeId": "A String", # Disk volume id. |
| 233 | }, |
| 234 | ], |
| 235 | }, |
| 236 | "storageStatusReport": [ # Output only. Storage reports collected periodically. |
| 237 | { # Status data for storage. |
| 238 | "disk": [ # Output only. Reports on disk |
| 239 | { # Status of the single storage device. |
| 240 | "bytesReadThisSession": "A String", # Output only. Number of bytes read since last boot. |
| 241 | "bytesWrittenThisSession": "A String", # Output only. Number of bytes written since last boot. |
| 242 | "discardTimeThisSession": "A String", # Output only. Time spent discarding since last boot. Discarding is writing to clear blocks which are no longer in use. Supported on kernels 4.18+. |
| 243 | "health": "A String", # Output only. Disk health. |
| 244 | "ioTimeThisSession": "A String", # Output only. Counts the time the disk and queue were busy, so unlike the fields above, parallel requests are not counted multiple times. |
| 245 | "manufacturer": "A String", # Output only. Disk manufacturer. |
| 246 | "model": "A String", # Output only. Disk model. |
| 247 | "readTimeThisSession": "A String", # Output only. Time spent reading from disk since last boot. |
| 248 | "serialNumber": "A String", # Output only. Disk serial number. |
| 249 | "sizeBytes": "A String", # Output only. Disk size. |
| 250 | "type": "A String", # Output only. Disk type: eMMC / NVMe / ATA / SCSI. |
| 251 | "volumeIds": [ # Output only. Disk volumes. |
| 252 | "A String", |
| 253 | ], |
| 254 | "writeTimeThisSession": "A String", # Output only. Time spent writing to disk since last boot. |
| 255 | }, |
| 256 | ], |
| 257 | "reportTime": "A String", # Output only. Timestamp of when the sample was collected on device |
| 258 | }, |
| 259 | ], |
| 260 | }, |
| 261 | ], |
| 262 | "nextPageToken": "A String", # Token to specify next page in the list. |
| 263 | }</pre> |
| 264 | </div> |
| 265 | |
| 266 | <div class="method"> |
| 267 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 268 | <pre>Retrieves the next page of results. |
| 269 | |
| 270 | Args: |
| 271 | previous_request: The request for the previous page. (required) |
| 272 | previous_response: The response from the request for the previous page. (required) |
| 273 | |
| 274 | Returns: |
| 275 | A request object that you can call 'execute()' on to request the next |
| 276 | page. Returns None if there are no more items in the collection. |
| 277 | </pre> |
| 278 | </div> |
| 279 | |
| 280 | </body></html> |