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

gcloud auth application-default login/google-cloud-sdk/lib/surface/alloydb/backups/__init__.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2021 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.
+
+"""Provide commands for managing AlloyDB backups."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.calliope import base
+
+
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA,
+                    base.ReleaseTrack.GA)
+class Backups(base.Group):
+  """Provide commands for managing AlloyDB backups.
+
+  Provide commands for managing AlloyDB backups including creating,
+  deleting, and listing backups.
+  """

gcloud auth application-default login/google-cloud-sdk/lib/surface/alloydb/backups/create.py

@@ -0,0 +1,184 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2021 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.
+"""Creates a new AlloyDB backup."""
+
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.alloydb import api_util
+from googlecloudsdk.api_lib.alloydb import backup_operations
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.alloydb import flags
+from googlecloudsdk.command_lib.kms import resource_args as kms_resource_args
+from googlecloudsdk.core import log
+from googlecloudsdk.core import properties
+from googlecloudsdk.core import resources
+
+
+def _ParseBackupType(alloydb_messages, backup_type):
+  if backup_type:
+    return alloydb_messages.Backup.TypeValueValuesEnum.lookup_by_name(
+        backup_type.upper())
+  return None
+
+
+# TODO: b/312466999 - Change @base.DefaultUniverseOnly to
+# @base.UniverseCompatible once b/312466999 is fixed.
+# See go/gcloud-cli-running-tpc-tests.
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA)
+class Create(base.CreateCommand):
+  """Creates a new AlloyDB backup within a given project."""
+
+  detailed_help = {
+      'DESCRIPTION': '{description}',
+      'EXAMPLES': """\
+        To create a new backup, run:
+
+          $ {command} my-backup --cluster=my-cluster --region=us-central1
+
+        To create a new cross-region backup, run:
+
+          $ {command} projects/my-project/locations/us-west1/backups/my-backup --cluster=my-cluster --region=us-central1
+        """,
+  }
+
+  @classmethod
+  def Args(cls, parser):
+    """Specifies additional command flags.
+
+    Args:
+      parser: argparse.Parser: Parser object for command line inputs.
+    """
+    base.ASYNC_FLAG.AddToParser(parser)
+    parser.add_argument(
+        '--region',
+        required=True,
+        type=str,
+        help='The region of the cluster to backup.',
+    )
+    parser.add_argument(
+        'backup',
+        type=str,
+        help=(
+            'The AlloyDB backup to create. This must either be the backup ID'
+            ' (myBackup) or the full backup path'
+            ' (projects/myProject/locations/us-central1/backups/myBackup). In'
+            ' the first case, the project and location are assumed to be the'
+            ' same as the cluster being backed up. The second form can be'
+            ' used to create cross-region and cross-project backups.'
+        ),
+    )
+    flags.AddCluster(parser, False)
+    flags.AddTags(parser)
+    kms_resource_args.AddKmsKeyResourceArg(
+        parser,
+        'backup',
+        permission_info=(
+            "The 'AlloyDB Service Agent' service account must hold permission"
+            " 'Cloud KMS CryptoKey Encrypter/Decrypter'"
+        ),
+    )
+
+  def ConstructResourceFromArgs(
+      self, alloydb_messages, cluster_ref, backup_ref, args
+  ):
+    backup_resource = alloydb_messages.Backup()
+    backup_resource.name = backup_ref.RelativeName()
+    backup_resource.type = _ParseBackupType(alloydb_messages, 'ON_DEMAND')
+    backup_resource.clusterName = cluster_ref.RelativeName()
+    backup_resource.tags = flags.GetTagsFromArgs(
+        args, alloydb_messages.Backup.TagsValue)
+    kms_key = flags.GetAndValidateKmsKeyName(args)
+    if kms_key:
+      encryption_config = alloydb_messages.EncryptionConfig()
+      encryption_config.kmsKeyName = kms_key
+      backup_resource.encryptionConfig = encryption_config
+    return backup_resource
+
+  def Run(self, args):
+    """Constructs and sends request.
+
+    Args:
+      args: argparse.Namespace, An object that contains the values for the
+          arguments specified in the .Args() method.
+
+    Returns:
+      ProcessHttpResponse of the request made.
+    """
+    client = api_util.AlloyDBClient(self.ReleaseTrack())
+    alloydb_client = client.alloydb_client
+    alloydb_messages = client.alloydb_messages
+    cluster_ref = client.resource_parser.Create(
+        'alloydb.projects.locations.clusters',
+        projectsId=properties.VALUES.core.project.GetOrFail,
+        locationsId=args.region,
+        clustersId=args.cluster)
+    backup_ref = client.resource_parser.Parse(
+        collection='alloydb.projects.locations.backups',
+        line=args.backup,
+        params={
+            'projectsId': properties.VALUES.core.project.GetOrFail,
+            'locationsId': args.region,
+        },
+    )
+
+    backup_resource = self.ConstructResourceFromArgs(
+        alloydb_messages, cluster_ref, backup_ref, args
+    )
+
+    req = alloydb_messages.AlloydbProjectsLocationsBackupsCreateRequest(
+        backup=backup_resource,
+        backupId=backup_ref.Name(),
+        parent=backup_ref.Parent().RelativeName(),
+    )
+    op = alloydb_client.projects_locations_backups.Create(req)
+    op_ref = resources.REGISTRY.ParseRelativeName(
+        op.name, collection='alloydb.projects.locations.operations')
+    log.status.Print('Operation ID: {}'.format(op_ref.Name()))
+    if not args.async_:
+      backup_operations.Await(op_ref, 'Creating backup', self.ReleaseTrack())
+    return op
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA)
+class CreateBeta(Create):
+  """Create a new AlloyDB backup within a given project."""
+
+  @classmethod
+  def Args(cls, parser):
+    super(CreateBeta, cls).Args(parser)
+    flags.AddEnforcedRetention(parser)
+
+  def ConstructResourceFromArgs(
+      self, alloydb_messages, cluster_ref, backup_ref, args
+  ):
+    backup_resource = super(CreateBeta, self).ConstructResourceFromArgs(
+        alloydb_messages, cluster_ref, backup_ref, args
+    )
+    if args.enforced_retention:
+      backup_resource.enforcedRetention = True
+    return backup_resource
+
+
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
+class CreateAlpha(CreateBeta):
+  """Create a new AlloyDB backup within a given project."""
+
+  @classmethod
+  def Args(cls, parser):
+    super(CreateAlpha, cls).Args(parser)

gcloud auth application-default login/google-cloud-sdk/lib/surface/alloydb/backups/delete.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2022 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.
+"""Deletes an AlloyDB backup."""
+
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+
+from googlecloudsdk.api_lib.alloydb import api_util
+from googlecloudsdk.api_lib.alloydb import backup_operations
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.alloydb import flags
+from googlecloudsdk.core import log
+from googlecloudsdk.core import properties
+from googlecloudsdk.core import resources
+from googlecloudsdk.core.console import console_io
+
+
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA,
+                    base.ReleaseTrack.GA)
+class Delete(base.DeleteCommand):
+  """Deletes an AlloyDB backup within a given project."""
+
+  detailed_help = {
+      'DESCRIPTION':
+          '{description}',
+      'EXAMPLES':
+          """\
+        To delete a backup, run:
+
+          $ {command} my-backup --region=us-central1
+        """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    """Specifies additional command flags.
+
+    Args:
+      parser: argparse.Parser, Parser object for command line inputs
+    """
+    base.ASYNC_FLAG.AddToParser(parser)
+    flags.AddBackup(parser)
+    flags.AddRegion(parser)
+
+  def Run(self, args):
+    """Constructs and sends request.
+
+    Args:
+      args: argparse.Namespace, An object that contains the values for the
+          arguments specified in the .Args() method.
+
+    Returns:
+      ProcessHttpResponse of the request made.
+    """
+    client = api_util.AlloyDBClient(self.ReleaseTrack())
+    alloydb_client = client.alloydb_client
+    alloydb_messages = client.alloydb_messages
+    backup_ref = client.resource_parser.Create(
+        'alloydb.projects.locations.backups',
+        projectsId=properties.VALUES.core.project.GetOrFail,
+        locationsId=args.region,
+        backupsId=args.backup)
+
+    prompt_message = (
+        'All of the backup data will be lost upon deletion.')
+    if not console_io.PromptContinue(message=prompt_message):
+      return None
+
+    req = alloydb_messages.AlloydbProjectsLocationsBackupsDeleteRequest(
+        name=backup_ref.RelativeName())
+    op = alloydb_client.projects_locations_backups.Delete(req)
+    op_ref = resources.REGISTRY.ParseRelativeName(
+        op.name, collection='alloydb.projects.locations.operations')
+    log.status.Print('Operation ID: {}'.format(op_ref.Name()))
+    if not args.async_:
+      backup_operations.Await(op_ref, 'Deleting backup', self.ReleaseTrack(), False)
+    return op

gcloud auth application-default login/google-cloud-sdk/lib/surface/alloydb/backups/describe.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2021 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.
+"""Creates a new AlloyDB backup."""
+
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.alloydb import api_util
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.alloydb import flags
+from googlecloudsdk.core import properties
+
+
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA,
+                    base.ReleaseTrack.GA)
+class Describe(base.DescribeCommand):
+  """Describes an AlloyDB backup in a given project and region."""
+
+  detailed_help = {
+      'DESCRIPTION':
+          '{description}',
+      'EXAMPLES':
+          """\
+        To describe a backup, run:
+
+          $ {command} my-backup --region=us-central1
+        """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    """Specifies additional command flags.
+
+    Args:
+      parser: argparse.Parser: Parser object for command line inputs.
+    """
+    flags.AddRegion(parser)
+    flags.AddBackup(parser)
+
+  def Run(self, args):
+    """Constructs and sends request.
+
+    Args:
+      args: argparse.Namespace, An object that contains the values for the
+          arguments specified in the .Args() method.
+
+    Returns:
+      ProcessHttpResponse of the request made.
+    """
+    client = api_util.AlloyDBClient(self.ReleaseTrack())
+    alloydb_client = client.alloydb_client
+    alloydb_messages = client.alloydb_messages
+    backup_ref = client.resource_parser.Create(
+        'alloydb.projects.locations.backups',
+        projectsId=properties.VALUES.core.project.GetOrFail,
+        locationsId=args.region,
+        backupsId=args.backup)
+
+    req = alloydb_messages.AlloydbProjectsLocationsBackupsGetRequest(
+        name=backup_ref.RelativeName())
+    return alloydb_client.projects_locations_backups.Get(req)

gcloud auth application-default login/google-cloud-sdk/lib/surface/alloydb/backups/list.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2021 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.
+"""Lists AlloyDB backups."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.alloydb import api_util
+from googlecloudsdk.calliope import base
+from googlecloudsdk.core import properties
+
+BACKUP_FORMAT = """
+    table(
+        name,
+        state:label=STATUS,
+        cluster_name,
+        create_time,
+        encryptionInfo.encryptionType:label=ENCRYPTION_TYPE
+    )
+"""
+
+
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA,
+                    base.ReleaseTrack.GA)
+class List(base.ListCommand):
+  """Lists AlloyDB backups in a given project.
+
+  Lists AlloyDB backups in a given project in the alphabetical order of the
+    backup name.
+  """
+
+  detailed_help = {
+      'DESCRIPTION':
+          '{description}',
+      'EXAMPLES':
+          """\
+        To list backups, run:
+
+          $ {command} --region=us-central1
+
+        Use the --format flag to customize the fields that are outputted. For
+        example, to list backups with their names and sizes, run:
+
+          $ {command} --region=us-central1 --format="table(name, size_bytes)"
+        """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    """Specifies additional command flags.
+
+    Args:
+      parser: argparse.Parser: Parser object for command line inputs.
+    """
+    parser.add_argument(
+        '--region',
+        default='-',
+        help=('Regional location (e.g. asia-east1, us-east1). See the full '
+              'list of regions at '
+              'https://cloud.google.com/sql/docs/instance-locations. '
+              'Default: list clusters in all regions.'))
+    parser.display_info.AddFormat(BACKUP_FORMAT)
+
+  def Run(self, args):
+    """Constructs and sends request.
+
+    Args:
+      args: argparse.Namespace, An object that contains the values for the
+          arguments specified in the .Args() method.
+
+    Returns:
+      ProcessHttpResponse of the request made.
+    """
+    client = api_util.AlloyDBClient(self.ReleaseTrack())
+    alloydb_client = client.alloydb_client
+    alloydb_messages = client.alloydb_messages
+    location_ref = client.resource_parser.Create(
+        'alloydb.projects.locations',
+        projectsId=properties.VALUES.core.project.GetOrFail,
+        locationsId=args.region)
+
+    result = api_util.YieldFromListHandlingUnreachable(
+        alloydb_client.projects_locations_backups,
+        alloydb_messages.AlloydbProjectsLocationsBackupsListRequest(
+            parent=location_ref.RelativeName()),
+        field='backups',
+        limit=args.limit,
+        batch_size=args.page_size,
+        batch_size_attribute='pageSize'
+    )
+
+    return result