132 lines
5.3 KiB
Python
132 lines
5.3 KiB
Python
# -*- coding: utf-8 -*- #
|
|
# Copyright 2023 Google LLC. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""Utility functions that modify a response.
|
|
|
|
These are most commonly used to inject code in declarative command
|
|
implementations.
|
|
"""
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import unicode_literals
|
|
|
|
|
|
def flatten_aggregated_list(field_name: str):
|
|
"""Collect resources returned from an aggregated list response into a list.
|
|
|
|
The aggregated list returns every instance of the resource in every scope
|
|
in a particular form. A partial example is given below:
|
|
{
|
|
"kind": "compute#storagePoolAggregatedList",
|
|
"id": "projects/cengizk-staging/aggregated/storagePools",
|
|
"items": {
|
|
"global": {
|
|
"warning": {
|
|
"code": "NO_RESULTS_ON_PAGE",
|
|
"message": "There are no results for scope 'global' on this page.",
|
|
"data": [
|
|
{
|
|
"key": "scope",
|
|
"value": "global"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"zones/us-central1-ir1": {
|
|
"storagePools": [
|
|
{
|
|
"kind": "compute#storagePool",
|
|
"id": "2014221622075011414",
|
|
"creationTimestamp": "2023-03-23T10:43:21.767-07:00",
|
|
"name": "foo",
|
|
},
|
|
{
|
|
"kind": "compute#storagePool",
|
|
"id": "5926595245683775672",
|
|
"creationTimestamp": "2023-04-05T09:48:24.926-07:00",
|
|
"name": "foo2",
|
|
"description": "",
|
|
"sizeGb": "1",
|
|
"provisionedIops": "5",
|
|
"zone": "https://www.googleapis.com/compute/staging_alpha/
|
|
projects/cengizk-staging/zones/us-central1-ir1",
|
|
"state": "READY",
|
|
"type": "SSD",
|
|
"resourceStatus": {
|
|
"numberOfDisks": "0",
|
|
"aggregateDiskSizeGb": "0",
|
|
"maxAggregateDiskSizeGb": "5",
|
|
"usedBytes": "0",
|
|
"usedReducedBytes": "0",
|
|
"aggregateDiskProvisionedIops": "0",
|
|
"lastResizeTimestamp": "1969-12-31T16:00:00.000-08:00"
|
|
},
|
|
{
|
|
"kind": "compute#storagePool",
|
|
"id": "8565305401462476119",
|
|
"creationTimestamp": "2025-06-11T23:29:12.208-07:00",
|
|
"name": "dennisx-exapool",
|
|
"description": "test description",
|
|
"zone":
|
|
"https://www.googleapis.com/compute/staging_alpha/projects/dennisx-staging/zones/us-central2-oj1",
|
|
"state": "READY",
|
|
"selfLink":
|
|
"https://www.googleapis.com/compute/staging_alpha/projects/dennisx-staging/zones/us-central2-oj1/storagePools/dennisx-exapool-2",
|
|
"selfLinkWithId":
|
|
"https://www.googleapis.com/compute/staging_alpha/projects/dennisx-staging/zones/us-central2-oj1/storagePools/8565305401462476119",
|
|
"storagePoolType":
|
|
"https://www.googleapis.com/compute/staging_alpha/projects/dennisx-staging/zones/us-central2-oj1/storagePoolTypes/exapool-hyperdisk-balanced",
|
|
"status": {
|
|
"diskCount": "2",
|
|
"poolUsedCapacityBytes": "1258019648",
|
|
"poolUserWrittenBytes": "21474836480",
|
|
"totalProvisionedDiskCapacityGb": "82400",
|
|
"maxTotalProvisionedDiskCapacityGb": "102400",
|
|
"totalProvisionedDiskIops": "20000",
|
|
"totalProvisionedDiskThroughput": "2000",
|
|
"exapoolMaxReadIops": "35840",
|
|
"exapoolMaxWriteIops": "5120",
|
|
"exapoolMaxReadThroughput": "665",
|
|
"exapoolMaxWriteThroughput": "51"
|
|
},
|
|
"capacityProvisioningType": "ADVANCED",
|
|
"performanceProvisioningType": "ADVANCED",
|
|
"exapoolProvisionedCapacityGb": {
|
|
"writeOptimized": "0",
|
|
"readOptimized": "0",
|
|
"capacityOptimized": "10240"
|
|
}
|
|
}
|
|
}
|
|
|
|
Args:
|
|
field_name: Name of the field that the resource is collected into. For the
|
|
example above, for the zone "us-central1-ir1", the resources are collected
|
|
into "storagePools", thus that must be the value. In general, this value
|
|
should be the plural camelcase form of the resource type.
|
|
|
|
Returns:
|
|
A function that can serve as a response modification hook. See
|
|
`modify_response_hooks` and `python_hook` in `yaml_command_schema.yaml`.
|
|
"""
|
|
def hook(response, _):
|
|
resources = []
|
|
|
|
for scope in response.items.additionalProperties:
|
|
resources += getattr(scope.value, field_name)
|
|
|
|
return resources
|
|
|
|
return hook
|