feat: Add new gcloud commands, API clients, and third-party libraries across various services.

gcloud auth application-default login/google-cloud-sdk/lib/surface/compute/project_zonal_metadata/__init__.py

@@ -0,0 +1,36 @@
+# -*- 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.
+"""Commands for reading and manipulating project zonal metadata."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.calliope import base
+
+
+@base.UniverseCompatible
+@base.ReleaseTracks(
+    base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA, base.ReleaseTrack.GA
+)
+class ProjectZonalMetadata(base.Group):
+  """Describe and update Compute Engine project zonal metadata."""
+
+
+ProjectZonalMetadata.category = base.INSTANCES_CATEGORY
+
+ProjectZonalMetadata.detailed_help = {
+    'brief': 'Describe and update project zonal metadata',
+}

gcloud auth application-default login/google-cloud-sdk/lib/surface/compute/project_zonal_metadata/add.py

@@ -0,0 +1,100 @@
+# -*- 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.
+"""Command for setting metadata on project zonal metadata."""
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.compute import base_classes
+from googlecloudsdk.api_lib.compute import instance_settings_metadata_utils as metadata_utils
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.compute.project_zonal_metadata import flags
+from googlecloudsdk.core import log
+from googlecloudsdk.core import properties
+
+
+@base.ReleaseTracks(
+    base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA, base.ReleaseTrack.GA
+)
+class AddMetadata(base.UpdateCommand):
+  # pylint:disable=line-too-long
+  """Add or update project zonal metadata.
+
+  *{command}* is used to add or update project zonal metadata for your VM
+  instances. Project zonal metadata values propagate to all VMs within the
+  specified zone. Every VM has access to a metadata server that you can use to
+  query the configured project zonal metadata values. To set metadata for
+  individual instances, use `gcloud compute instances add-metadata`. For
+  information about metadata, see
+  [](https://cloud.google.com/compute/docs/metadata).
+
+  Only the metadata keys that you provide in the command get mutated. All other
+  existing metadata entries remain the same.
+  """
+  # pylint:enable=line-too-long
+
+  detailed_help = {'EXAMPLES': """\
+        To set the project zonal metadata with key=value in the zone ``us-central1-a''
+        for the project ``my-gcp-project'', run:
+
+        $ {command} --metadata=key=value
+        --zone=us-central1-a --project=my-gcp-project
+
+        For more information and examples for setting project zonal metadata, see
+        [](https://cloud.google.com/compute/docs/metadata/setting-custom-metadata#set-custom-project-zonal-metadata)
+      """}
+
+  @staticmethod
+  def Args(parser):
+    flags.ProjectZonalMetadataAddMetadataFlags(parser)
+
+  def Run(self, args):
+    holder = base_classes.ComputeApiHolder(self.ReleaseTrack())
+    client = holder.client
+    service = client.apitools_client.instanceSettings
+    get_request = client.messages.ComputeInstanceSettingsGetRequest(
+        project=properties.VALUES.core.project.GetOrFail(), zone=args.zone
+    )
+    existing_instance_settings = client.MakeRequests(
+        [(service, 'Get', get_request)]
+    )[0]
+    fingerprint = existing_instance_settings.fingerprint
+    if metadata_utils.IsRequestMetadataSameAsExistingMetadata(
+        args.metadata,
+        metadata_utils.ConstructMetadataDict(
+            existing_instance_settings.metadata
+        ),
+    ):
+      log.status.Print(
+          'No change requested; skipping update for project zonal metadata in'
+          ' zone [{0}].'.format(existing_instance_settings.zone)
+      )
+      return existing_instance_settings.metadata
+    request = client.messages.ComputeInstanceSettingsPatchRequest(
+        instanceSettings=client.messages.InstanceSettings(
+            fingerprint=fingerprint,
+            metadata=metadata_utils.ConstructInstanceSettingsMetadataMessage(
+                client.messages, args.metadata
+            ),
+        ),
+        project=properties.VALUES.core.project.GetOrFail(),
+        updateMask=metadata_utils.ConstructUpdateMask(args.metadata.keys()),
+        zone=args.zone,
+    )
+    # TODO(b/271293873):Remove no_followup=True once singleton support is added.
+    return client.MakeRequests(
+        [(service, 'Patch', request)],
+        no_followup=True,
+    )[0]

gcloud auth application-default login/google-cloud-sdk/lib/surface/compute/project_zonal_metadata/describe.py

@@ -0,0 +1,59 @@
+# -*- 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.
+"""Command for describing project zonal metadata."""
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+import base64
+
+from googlecloudsdk.api_lib.compute import base_classes
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.compute.project_zonal_metadata import flags
+from googlecloudsdk.core import properties
+
+
+@base.ReleaseTracks(
+    base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA, base.ReleaseTrack.GA
+)
+class Describe(base.DescribeCommand):
+  """Describe project zonal metadata."""
+
+  detailed_help = {'EXAMPLES': """
+        To describe the project zonal metadata in the zone ``us-central1-a''
+        for the project ``my-gcp-project'', run:
+
+          $ {command} --zone=us-central1-a --project=my-gcp-project
+      """}
+
+  @staticmethod
+  def Args(parser):
+    flags.AddDescribeProjectZonalMetadataFlags(parser)
+
+  def Run(self, args):
+    holder = base_classes.ComputeApiHolder(self.ReleaseTrack())
+    client = holder.client
+    service = client.apitools_client.instanceSettings
+    request = client.messages.ComputeInstanceSettingsGetRequest(
+        project=properties.VALUES.core.project.GetOrFail(), zone=args.zone
+    )
+    response = client.MakeRequests([(service, 'Get', request)])[0]
+    return {
+        'fingerprint': str(
+            base64.encodebytes(response.fingerprint), 'utf-8'
+        ).rstrip('\n'),
+        'metadata': response.metadata,
+        'zone': response.zone,
+    }

gcloud auth application-default login/google-cloud-sdk/lib/surface/compute/project_zonal_metadata/remove.py

@@ -0,0 +1,101 @@
+# -*- 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.
+"""Command for setting metadata on project zonal metadata."""
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.compute import base_classes
+from googlecloudsdk.api_lib.compute import instance_settings_metadata_utils as metadata_utils
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.compute.project_zonal_metadata import flags
+from googlecloudsdk.core import log
+from googlecloudsdk.core import properties
+
+
+@base.ReleaseTracks(
+    base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA, base.ReleaseTrack.GA
+)
+class RemoveMetadata(base.UpdateCommand):
+  # pylint:disable=line-too-long
+  """Remove project zonal metadata.
+
+  *{command}* is used to remove project zonal metadata from all VMs within the
+  specified zone. For information about metadata, see
+  [](https://cloud.google.com/compute/docs/metadata).
+
+  Only the metadata keys that you provide in the command get removed. All other
+  existing metadata entries remain the same.
+
+  After you remove a specific project zonal metadata entry, if that metadata key
+  has any project-wide value configured, then the VMs in the zone automatically
+  inherit that project-wide value.
+  """
+  # pylint:enable=line-too-long
+
+  detailed_help = {'EXAMPLES': """\
+        To remove the project zonal metadata with key=value in the zone ``us-central1-a''
+        for the project ``my-gcp-project'', run:
+
+        $ {command} --keys=key --zone=us-central1-a --project=my-gcp-project
+
+        For more information and examples about how to remove project zonal
+        metadata, see [](https://cloud.google.com/compute/docs/metadata/setting-custom-metadata#remove-custom-project-zonal-metadata)
+      """}
+
+  @staticmethod
+  def Args(parser):
+    flags.ProjectZonalMetadataRemoveMetadataFlags(parser)
+
+  def Run(self, args):
+    holder = base_classes.ComputeApiHolder(self.ReleaseTrack())
+    client = holder.client
+    service = client.apitools_client.instanceSettings
+    get_request = client.messages.ComputeInstanceSettingsGetRequest(
+        project=properties.VALUES.core.project.GetOrFail(), zone=args.zone
+    )
+    existing_instance_settings = client.MakeRequests(
+        [(service, 'Get', get_request)]
+    )[0]
+    fingerprint = existing_instance_settings.fingerprint
+    existing_metadata = metadata_utils.ConstructMetadataDict(
+        existing_instance_settings.metadata
+    )
+    keys_not_in_existing_metadata = set(args.keys) - set(
+        existing_metadata.keys()
+    )
+    if keys_not_in_existing_metadata:
+      log.status.Print(
+          'Provide only valid keys. Keys that do not exist in current project'
+          ' zonal metadata in zone [{0}] are {1}.'.format(
+              existing_instance_settings.zone, keys_not_in_existing_metadata
+          )
+      )
+      return existing_instance_settings.metadata
+    request = client.messages.ComputeInstanceSettingsPatchRequest(
+        instanceSettings=client.messages.InstanceSettings(
+            fingerprint=fingerprint,
+            metadata=client.messages.InstanceSettingsMetadata(),
+        ),
+        project=properties.VALUES.core.project.GetOrFail(),
+        updateMask=metadata_utils.ConstructUpdateMask(
+            existing_metadata.keys() if args.all else set(args.keys)
+        ),
+        zone=args.zone,
+    )
+    return client.MakeRequests(
+        [(service, 'Patch', request)],
+        no_followup=True,
+    )[0]