Skip to content

Commit

Permalink
feat(chromemanagement): update the api
Browse files Browse the repository at this point in the history
#### chromemanagement:v1

The following keys were added:
- schemas.GoogleChromeManagementV1RuntimeCountersReport (Total Keys: 12)
- schemas.GoogleChromeManagementV1TelemetryDevice.properties.runtimeCountersReport (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Mar 5, 2024
1 parent 4ba1346 commit 35aff64
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 11 deletions.
22 changes: 20 additions & 2 deletions docs/dyn/chromemanagement_v1.customers.telemetry.devices.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3>Method Details</h3>

Args:
name: string, Required. Name of the `TelemetryDevice` to return. (required)
readMask: string, Required. Read mask to specify which fields to return.
readMask: string, Required. Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - device_id - serial_number - cpu_info - cpu_status_report - memory_info - memory_status_report - network_info - network_diagnostics_report - network_status_report - os_update_status - graphics_info - graphics_status_report - battery_info - battery_status_report - storage_info - storage_status_report - thunderbolt_info - audio_status_report - boot_performance_report - heartbeat_status_report - network_bandwidth_report - peripherals_report - kiosk_app_status_report - app_report - runtime_counters_report
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down Expand Up @@ -339,6 +339,15 @@ <h3>Method Details</h3>
],
},
],
&quot;runtimeCountersReport&quot;: [ # Output only. Runtime counters reports collected device lifetime runtime, as well as the counts of S0-&gt;S3, S0-&gt;S4, and S0-&gt;S5 transitions, meaning entering into sleep, hibernation, and power-off states
{ # Runtime counters retrieved from CPU. Currently the runtime counters telemetry is only supported by Intel vPro PSR on Gen 14+.
&quot;enterHibernationCount&quot;: &quot;A String&quot;, # Number of times that the device has entered into the hibernation state. Currently obtained via the PSR, count from S0-&gt;S4.
&quot;enterPoweroffCount&quot;: &quot;A String&quot;, # Number of times that the device has entered into the power-off state. Currently obtained via the PSR, count from S0-&gt;S5.
&quot;enterSleepCount&quot;: &quot;A String&quot;, # Number of times that the device has entered into the sleep state. Currently obtained via the PSR, count from S0-&gt;S3.
&quot;reportTime&quot;: &quot;A String&quot;, # Timestamp when the report was collected.
&quot;uptimeRuntimeDuration&quot;: &quot;A String&quot;, # Total lifetime runtime. Currently always S0 runtime from Intel vPro PSR.
},
],
&quot;serialNumber&quot;: &quot;A String&quot;, # Output only. Device serial number. This value is the same as the Admin Console&#x27;s Serial Number in the ChromeOS Devices tab.
&quot;storageInfo&quot;: { # Status data for storage. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceStorageStatus](https://chromeenterprise.google/policies/#ReportDeviceStorageStatus) * Data Collection Frequency: Only at Upload * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_STORAGE_INFO # Output only. Information of storage specs for the device.
&quot;availableDiskBytes&quot;: &quot;A String&quot;, # The available space for user data storage in the device in bytes.
Expand Down Expand Up @@ -392,7 +401,7 @@ <h3>Method Details</h3>
filter: string, Optional. Only include resources that match the filter. Supported filter fields: - org_unit_id - serial_number - device_id - reports_timestamp The &quot;reports_timestamp&quot; filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC &quot;Zulu&quot; format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: &quot;2014-10-02T15:01:23Z&quot;, &quot;2014-10-02T15:01:23.045123456Z&quot;, &quot;1679283943823&quot;.
pageSize: integer, Maximum number of results to return. Default value is 100. Maximum value is 1000.
pageToken: string, Token to specify next page in the list.
readMask: string, Required. Read mask to specify which fields to return.
readMask: string, Required. Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - device_id - serial_number - cpu_info - cpu_status_report - memory_info - memory_status_report - network_info - network_diagnostics_report - network_status_report - os_update_status - graphics_info - graphics_status_report - battery_info - battery_status_report - storage_info - storage_status_report - thunderbolt_info - audio_status_report - boot_performance_report - heartbeat_status_report - network_bandwidth_report - peripherals_report - kiosk_app_status_report - app_report - runtime_counters_report
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down Expand Up @@ -635,6 +644,15 @@ <h3>Method Details</h3>
],
},
],
&quot;runtimeCountersReport&quot;: [ # Output only. Runtime counters reports collected device lifetime runtime, as well as the counts of S0-&gt;S3, S0-&gt;S4, and S0-&gt;S5 transitions, meaning entering into sleep, hibernation, and power-off states
{ # Runtime counters retrieved from CPU. Currently the runtime counters telemetry is only supported by Intel vPro PSR on Gen 14+.
&quot;enterHibernationCount&quot;: &quot;A String&quot;, # Number of times that the device has entered into the hibernation state. Currently obtained via the PSR, count from S0-&gt;S4.
&quot;enterPoweroffCount&quot;: &quot;A String&quot;, # Number of times that the device has entered into the power-off state. Currently obtained via the PSR, count from S0-&gt;S5.
&quot;enterSleepCount&quot;: &quot;A String&quot;, # Number of times that the device has entered into the sleep state. Currently obtained via the PSR, count from S0-&gt;S3.
&quot;reportTime&quot;: &quot;A String&quot;, # Timestamp when the report was collected.
&quot;uptimeRuntimeDuration&quot;: &quot;A String&quot;, # Total lifetime runtime. Currently always S0 runtime from Intel vPro PSR.
},
],
&quot;serialNumber&quot;: &quot;A String&quot;, # Output only. Device serial number. This value is the same as the Admin Console&#x27;s Serial Number in the ChromeOS Devices tab.
&quot;storageInfo&quot;: { # Status data for storage. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceStorageStatus](https://chromeenterprise.google/policies/#ReportDeviceStorageStatus) * Data Collection Frequency: Only at Upload * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_STORAGE_INFO # Output only. Information of storage specs for the device.
&quot;availableDiskBytes&quot;: &quot;A String&quot;, # The available space for user data storage in the device in bytes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3>Method Details</h3>
filter: string, Optional. Only include resources that match the filter. Although this parameter is currently optional, this parameter will be required- please specify at least 1 event type. Supported filter fields: - device_id - user_id - device_org_unit_id - user_org_unit_id - timestamp - event_type The &quot;timestamp&quot; filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC &quot;Zulu&quot; format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: &quot;2014-10-02T15:01:23Z&quot;, &quot;2014-10-02T15:01:23.045123456Z&quot;, &quot;1679283943823&quot;.
pageSize: integer, Optional. Maximum number of results to return. Default value is 100. Maximum value is 1000.
pageToken: string, Optional. Token to specify next page in the list.
readMask: string, Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required.
readMask: string, Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down
4 changes: 2 additions & 2 deletions docs/dyn/chromemanagement_v1.customers.telemetry.users.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3>Method Details</h3>

Args:
name: string, Required. Name of the `TelemetryUser` to return. (required)
readMask: string, Read mask to specify which fields to return.
readMask: string, Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down Expand Up @@ -172,7 +172,7 @@ <h3>Method Details</h3>
filter: string, Only include resources that match the filter. Supported filter fields: - user_id - user_org_unit_id
pageSize: integer, Maximum number of results to return. Default value is 100. Maximum value is 1000.
pageToken: string, Token to specify next page in the list.
readMask: string, Read mask to specify which fields to return.
readMask: string, Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down
52 changes: 46 additions & 6 deletions googleapiclient/discovery_cache/documents/chromemanagement.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -746,7 +746,7 @@
"type": "string"
},
"readMask": {
"description": "Required. Read mask to specify which fields to return.",
"description": "Required. Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - device_id - serial_number - cpu_info - cpu_status_report - memory_info - memory_status_report - network_info - network_diagnostics_report - network_status_report - os_update_status - graphics_info - graphics_status_report - battery_info - battery_status_report - storage_info - storage_status_report - thunderbolt_info - audio_status_report - boot_performance_report - heartbeat_status_report - network_bandwidth_report - peripherals_report - kiosk_app_status_report - app_report - runtime_counters_report ",
"format": "google-fieldmask",
"location": "query",
"type": "string"
Expand Down Expand Up @@ -793,7 +793,7 @@
"type": "string"
},
"readMask": {
"description": "Required. Read mask to specify which fields to return.",
"description": "Required. Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - device_id - serial_number - cpu_info - cpu_status_report - memory_info - memory_status_report - network_info - network_diagnostics_report - network_status_report - os_update_status - graphics_info - graphics_status_report - battery_info - battery_status_report - storage_info - storage_status_report - thunderbolt_info - audio_status_report - boot_performance_report - heartbeat_status_report - network_bandwidth_report - peripherals_report - kiosk_app_status_report - app_report - runtime_counters_report ",
"format": "google-fieldmask",
"location": "query",
"type": "string"
Expand Down Expand Up @@ -844,7 +844,7 @@
"type": "string"
},
"readMask": {
"description": "Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required.",
"description": "Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event ",
"format": "google-fieldmask",
"location": "query",
"type": "string"
Expand Down Expand Up @@ -972,7 +972,7 @@
"type": "string"
},
"readMask": {
"description": "Read mask to specify which fields to return.",
"description": "Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report ",
"format": "google-fieldmask",
"location": "query",
"type": "string"
Expand Down Expand Up @@ -1019,7 +1019,7 @@
"type": "string"
},
"readMask": {
"description": "Read mask to specify which fields to return.",
"description": "Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report ",
"format": "google-fieldmask",
"location": "query",
"type": "string"
Expand All @@ -1040,7 +1040,7 @@
}
}
},
"revision": "20240225",
"revision": "20240303",
"rootUrl": "https://chromemanagement.googleapis.com/",
"schemas": {
"GoogleChromeManagementV1AndroidAppInfo": {
Expand Down Expand Up @@ -3113,6 +3113,38 @@
},
"type": "object"
},
"GoogleChromeManagementV1RuntimeCountersReport": {
"description": "Runtime counters retrieved from CPU. Currently the runtime counters telemetry is only supported by Intel vPro PSR on Gen 14+.",
"id": "GoogleChromeManagementV1RuntimeCountersReport",
"properties": {
"enterHibernationCount": {
"description": "Number of times that the device has entered into the hibernation state. Currently obtained via the PSR, count from S0->S4.",
"format": "int64",
"type": "string"
},
"enterPoweroffCount": {
"description": "Number of times that the device has entered into the power-off state. Currently obtained via the PSR, count from S0->S5.",
"format": "int64",
"type": "string"
},
"enterSleepCount": {
"description": "Number of times that the device has entered into the sleep state. Currently obtained via the PSR, count from S0->S3.",
"format": "int64",
"type": "string"
},
"reportTime": {
"description": "Timestamp when the report was collected.",
"format": "google-datetime",
"type": "string"
},
"uptimeRuntimeDuration": {
"description": "Total lifetime runtime. Currently always S0 runtime from Intel vPro PSR.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GoogleChromeManagementV1StorageInfo": {
"description": "Status data for storage. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceStorageStatus](https://chromeenterprise.google/policies/#ReportDeviceStorageStatus) * Data Collection Frequency: Only at Upload * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_STORAGE_INFO",
"id": "GoogleChromeManagementV1StorageInfo",
Expand Down Expand Up @@ -3344,6 +3376,14 @@
"readOnly": true,
"type": "array"
},
"runtimeCountersReport": {
"description": "Output only. Runtime counters reports collected device lifetime runtime, as well as the counts of S0->S3, S0->S4, and S0->S5 transitions, meaning entering into sleep, hibernation, and power-off states",
"items": {
"$ref": "GoogleChromeManagementV1RuntimeCountersReport"
},
"readOnly": true,
"type": "array"
},
"serialNumber": {
"description": "Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab.",
"readOnly": true,
Expand Down

0 comments on commit 35aff64

Please sign in to comment.